BrandKity MCP

Crie kits de marca completos com um único prompt.

Documentação

@brandkity/mcp — BrandKity MCP Server

Servidor Model Context Protocol para BrandKity — crie e gerencie brand kits a partir de qualquer agente de IA (Claude Desktop, Cursor, Windsurf ou qualquer cliente compatível com MCP).

Versão Atual: 1.4.3 — MCP agora disponível nos planos Starter, Pro e Agency

Início Rápido

1. Obtenha uma Chave de API

Entre em brandkity.com
Vá para Configurações → Chaves de API
Clique em Gerar Nova Chave e copie a chave (bk_live_...)

Disponível nos planos Starter, Pro e Agency. Cadastre-se gratuitamente para explorar e, em seguida, faça upgrade para Starter ou superior para executar chamadas de ferramentas.

2. Configure Seu Cliente de IA

Claude Desktop

Edite ~/Library/Application Support/Claude/claude_desktop_config.json (Mac) ou %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "brandkity": {
      "command": "npx",
      "args": ["-y", "@brandkity/mcp"],
      "env": {
        "BRANDKITY_API_KEY": "bk_live_your_key_here"
      }
    }
  }
}

Cursor

Edite .cursor/mcp.json:

{
  "mcpServers": {
    "brandkity": {
      "command": "npx",
      "args": ["-y", "@brandkity/mcp"],
      "env": {
        "BRANDKITY_API_KEY": "bk_live_your_key_here"
      }
    }
  }
}

Windsurf

Edite ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "brandkity": {
      "command": "npx",
      "args": ["-y", "@brandkity/mcp"],
      "env": {
        "BRANDKITY_API_KEY": "bk_live_your_key_here"
      }
    }
  }
}

3. Use

Depois de configurado, peça ao seu agente de IA para criar um brand kit:

"Crie um brand kit para a Acme Corp com a cor de destaque #E55B00. Adicione um bloco Colors com a paleta primária (Orange Flame #E55B00, Midnight #1A1A2E, Canvas #FAF9F7) e um bloco Typography com Inter para títulos e DM Sans para corpo. Envie os logos de /Users/me/acme/logos/."

Ferramentas Disponíveis (22)

Ferramenta	Descrição
Workspace
`get_workspace`	Obtenha informações do workspace (plano, quantidade de kits, armazenamento)
Arquivos
`upload_file`	Envie qualquer arquivo local para o armazenamento do workspace → retorna uma URL pública
`list_files`	Liste os arquivos do workspace com filtro por tipo e paginação
Kits
`list_kits`	Liste todos os brand kits (filtre por rascunho/publicados/todos)
`create_kit`	Crie um novo kit → retorna kit_id
`get_kit`	Obtenha um kit com todos os blocos e conteúdo
`update_kit`	Atualize as configurações do kit (nome, cor, template, logo_url, cover_image_url, campos white-label)
`publish_kit`	Publique um kit → retorna URL pública
`unpublish_kit`	Despublique um kit (reverte para rascunho)
Blocos
`list_blocks`	Liste todos os blocos de um kit com IDs e tipos
`ensure_block`	Idempotente — retorna o block_id existente ou cria um novo bloco (preferível ao add_block)
`add_block`	Adicione um bloco incondicionalmente (use ensure_block para evitar duplicatas)
`update_block`	Atualize nome/visibilidade do bloco
`delete_block`	Exclua permanentemente um bloco e todo o seu conteúdo
Conteúdo
`add_colors`	Adicione amostras de cor a um bloco Colors
`add_typography`	Adicione entradas de fonte a um bloco Typography
`set_brand_story`	Defina conteúdo de texto rico (história da marca, tom de voz)
`set_block_note`	Defina a nota editorial exibida acima de qualquer bloco
Upload
`upload_asset`	Envie um arquivo local para um bloco (logos, visuais, vídeos etc.) com nova tentativa automática
`upload_assets_batch`	Envie vários arquivos locais para o mesmo bloco; remove duplicatas por caminho de arquivo
`upload_kit_logo`	Envie e defina o logo do cabeçalho do kit
`upload_cover_image`	Envie e defina a imagem de capa do kit

Marca White-Label (Recurso Pro+)

Personalize seu portal com favicon personalizado, imagem de compartilhamento social e metadados de SEO:

// Upload custom assets
const faviconUrl = await client.uploadFile('favicon.ico', faviconBuffer);
const ogImageUrl = await client.uploadFile('og-image.png', ogImageBuffer);

// Apply white-label branding
await client.updateKit('kit-id', {
  og_title: 'Acme Corp Brand Guidelines',
  og_description: 'Official brand assets and standards',
  custom_favicon_url: faviconUrl,
  og_image_url: ogImageUrl,
});

Campos:

og_title (string, máx. 100 caracteres) — título de SEO para compartilhamento social
og_description (string, máx. 300 caracteres) — descrição de SEO
custom_favicon_url (string) — URL de CDN para favicon (ICO/PNG/SVG)
og_image_url (string) — URL de CDN para imagem de compartilhamento social (1200×630 px recomendado)

Requisitos do Plano:

Gratuito: campos white-label são somente leitura; chamadas de ferramentas MCP retornam 403
Starter/Pro/Agency: acesso MCP completo; campos white-label são de leitura e gravação no Pro/Agency

Variáveis de Ambiente

Variável	Obrigatória	Padrão	Descrição
`BRANDKITY_API_KEY`	Sim	—	Token de Acesso Pessoal (`bk_live_...`)
`BRANDKITY_API_URL`	Não	`https://brandkity.com`	URL base da API (para desenvolvimento local)

Fluxo de Trabalho Típico

1. get_workspace       → verify connection, check plan and storage
2. list_kits           → confirm kit doesn't already exist
3. create_kit          → returns kit_id
4. ensure_block        → idempotent: returns existing block_id or creates a new one (for each block type)
5. add_colors          → populate the Colors block
6. add_typography      → populate the Typography block
7. upload_file         → upload font/logo/cover files to workspace storage
8. upload_asset        → upload logos, images, videos into blocks
9. set_brand_story     → write the brand story in a rich_text block
10. set_block_note     → add usage guidance to any block
11. publish_kit        → make the portal live

Notas de Confiabilidade (v1.4.0)

Sem blocos duplicados — ensure_block é idempotente. Reexecutar um fluxo de trabalho nunca cria blocos duplicados.
Nova tentativa automática em uploads — upload_asset e upload_file tentam novamente até 3 vezes em erros de rede com backoff exponencial.
Tempos limite conscientes do tamanho — O tempo limite de upload aumenta com o tamanho do arquivo (60 s base + 20 s por 10 MB, máx. 10 min). Arquivos grandes, como vídeos de 64 MB, são tratados de forma confiável.
Remoção de duplicatas em lote — upload_assets_batch ignora silenciosamente entradas file_path duplicadas para que o mesmo arquivo nunca seja enviado duas vezes em um lote.
Instruções do agente — O servidor agora fornece regras de operação aos clientes de IA no momento da conexão, reduzindo automaticamente operações duplicadas dos agentes de IA.
Resolução de URL white-label — URLs de CDN em campos white-label são resolvidas automaticamente para IDs de ativos no servidor; os agentes não precisam gerenciar IDs de ativos diretamente.
Rastreamento de armazenamento — Todos os uploads de arquivos são rastreados por workspace para aplicação precisa da cota.

Licença

MIT