Configurar o Tulip MCP

Prev Next

Como faço para configurar o Tulip MCP?

A documentação detalhada de configuração do Tulip MCP está disponível no repositório oficial: https://github.com/tulip/tulip-mcp/tree/master

A configuração do Tulip MCP foi simplificada. O novo processo envolve três etapas principais:

  1. Configurar suas credenciais
  2. Executar o servidor
  3. Conectar-se a um cliente MCP

Pré-requisitos

Antes de começar, verifique se você tem o Node.js instalado em seu sistema. Isso é necessário para executar o servidor.

Verifique sua versão do npm e do Node.jsExecuteos seguintes comandos em seu terminal/Terminal do Windows (Prompt de Comando, PowerShell):

node -vnpm -vSevocê obtiver um nome de versão, estará pronto e poderá continuar na etapa 1. Caso contrário, vá para node.js e instale a versão mais recente para o seu sistema operacional.

Configure suas credenciais de API da Tulip

Para se conectar à Tulip via API, você precisa criar um arquivo .env que armazene com segurança suas credenciais de API.

1. Crie uma pasta de configuração

Escolha ou crie uma pasta onde deseja armazenar o arquivo de configuração do ambiente.

Guia: Criar um arquivo .env

Esse arquivo armazenará suas credenciais do Tulip. Um exemplo de arquivo .env está disponível aqui.

Usuários de Mac:

  1. Abra o Terminal e execute os seguintes comandos:

bashtouch .envnano .env2. Cole o modelo de credenciais (na próxima etapa) no novo arquivo.3. Após adicionar suas credenciais, siga as instruções de salvamento abaixo.

Usuários do Windows:

  1. Abra o Bloco de Notas.
  2. Cole o modelo de credenciais (na próxima etapa) no novo arquivo.
  3. Depois de adicionar suas credenciais, siga as instruções de salvamento abaixo.

2. Adicione suas credenciais do Tulip

Copie e cole o seguinte no arquivo .env, substituindo os valores do espaço reservado por suas credenciais reais:

TULIP_API_KEY=sua_api_key_aquiTULIP_API_SECRET=sua_api_secret_aquiTULIP_BASE_URL=https://your-instance.tulip.coTULIP_WORKSPACE_ID=your_workspace_id_here_if_using_account_api_key

  • TULIP_BASE_URL: Esse é o URL que você usa para acessar a Tulip.
    Exemplo: https://my-company.tulip.co
  • TULIP_WORKSPACE_ID: encontrado em sua URL da Tulip após /w/.
    Exemplo: Em https://my-company.tulip.co/w/DEFAULT, o ID do espaço de trabalho é DEFAULT.

:::(Warning) (Importante) Somente inclua TULIP_WORKSPACE_ID se estiver utilizando uma Account API Key (das Account Settings).

Se estiver usando uma Chave de API do espaço de trabalho(em Configurações do espaço de trabalho), você pode deixar esse field em branco.
:::
Salve o arquivo e verifique se ele está localizado na pasta que você especificou.

3. Executar o servidor

Depois que o arquivo .env estiver configurado, você poderá iniciar o servidor.

Abra o terminal ou o prompt de comando, navegue até a pasta que contém o arquivo .env e execute o seguinte comando:

bashnpx @tulip/mcp-serverOcomando fará o download da versão mais recente do servidor Tulip MCP e o iniciará. O servidor está agora em execução e pronto para ser conectado a um cliente MCP.

4. Conectar-se ao Tulip MCP

Quando um cliente MCP executa o servidor, ele pode não estar no mesmo diretório que o arquivo .env, portanto, não encontrará as credenciais automaticamente. Para corrigir isso, você deve fornecer o caminho completo para o arquivo .env usando o sinalizador --env na configuração do cliente.

Guia: Localização do caminho do arquivo .env

  1. Navegue até a pasta em que você criou o arquivo .env.
  2. No Windows: Clique com o botão direito do mouse no arquivo .env enquanto mantém pressionada a tecla Shift e selecione "Copiar como caminho".
  3. No macOS: Clique com o botão direito do mouse no arquivo .env, mantenha pressionada a tecla Option e selecione "Copy .env as Pathname".
  4. Você usará esse caminho copiado na configuração do cliente abaixo.

Guia: Área de trabalho do Claude

  1. Na barra de menus do Claude Desktop, selecione Settings... > Developer > Edit Config.
  2. Isso abrirá o arquivo claude_desktop_config.json.
  3. Adicione a configuração do servidor dentro do objeto mcpServers. Você deve substituir "C:\\path\\to\\your\\.env" pelo caminho real que você copiou. json { " mcpServers": { "tulip-mcp": { "command": "npx", "args": [ "@tulip/mcp-server", "--env", "C:\\path\\to\\your\\.env" ] } } }
  4. Salve o arquivo e reinicie o Claude Desktop.

Para obter mais detalhes, consulte o Início rápido oficial do Claude Desktop MCP.

Cursor

Para uma configuração mais fácil, clique no botão abaixo. Isso preencherá previamente o comando no Cursor.

Conectar-se ao Cursor

Depois de clicar no botão, você deve substituir o texto do espaço reservado(REPLACE_WITH_YOUR_ENV_FILE_PATH_HERE) pelo caminho completo do arquivo .env que você copiou anteriormente.

Configuração avançada

Obtenção de credenciais de API da Tulip

Você pode criar credenciais de API (Tokens) nas configurações do site Tulip instance.

  1. Faça login: Acesse seu site Tulip instance.
  2. Navegue até API Tokens: Vá para Settings > API Tokens.
  3. Crie um novo token de API: Gere um novo token, dando a ele um nome descritivo (por exemplo, "MCP Server").
  4. Configure Scopes (Escopos): Conceda ao token as permissões necessárias (escopos). Um bom conjunto inicial de escopos para acesso básico é: stations:read, users:read, tables:read, machines:read, apps:read, urls:sign
  5. Copie as credenciais: Copie a chave e o segredo da API gerados e cole-os em seu arquivo .env.

Configuração da seleção de ferramentas

Por padrão, por segurança, o servidor habilita somente ferramentas de leitura e de tabela. Você pode personalizar quais ferramentas estão disponíveis usando a variável de ambiente ENABLED_TOOLS em seu arquivo .env.

A variável ENABLED_TOOLS aceita uma lista separada por vírgulas que pode incluir:

  • Nomes de ferramentas individuais: Ferramentas específicas, como listStations.
  • Categorias: Agrupamentos baseados em segurança(somente leitura, gravação, administrador).
  • Tipos: Agrupamentos baseados em recursos(tabela, máquina, usuário, aplicativo, interface, estação, grupo de estações, utilitário).

Exemplos:


# Habilitar todas as operações de leitura e gravação

ENABLED\_TOOLS=somente leitura,gravação

# Habilitar todas as ferramentas relacionadas a tabelas e estações

ENABLED\_TOOLS=tabela,estação

# Habilitar ferramentas específicas

ENABLED\_TOOLS=listStations,addRecord

# Uma abordagem mista recomendada

ENABLED\_TOOLS=read-only,interface,station,user

# Habilitar tudo (use com cuidado, pois isso permite a exclusão/arquivamento de dados)

ENABLED\_TOOLS=read-only,write,admin```

**Artigos relacionados**

* [Configurar uma API Tulip](/r230/docs/set-up-a-tulip-api)