Conectar projeto Apidog à IA

O Apidog MCP Server permite que a IA se conecte e utilize especificações de API dentro do seu projeto Apidog, permitindo que assistentes de IA gerem código, pesquisem especificações e acelerem fluxos de trabalho de desenvolvimento.

Pré-requisitos

Antes de configurar o cliente MCP, certifique-se de que você tenha:

Node.js (versão 18 ou posterior, preferencialmente a versão LTS mais recente)

Uma IDE compatível com MCP:

Cursor

VS Code + plugin Cline

Outros editores compatíveis com MCP

Obtenção das credenciais necessárias

Gerar token de acesso à API

Abra o Apidog e passe o cursor sobre a sua foto de perfil (canto superior direito)

Selecione Configurações da conta → Token de acesso à API

Crie um novo token de acesso à API

Copie o token para substituir <access-token> na configuração

Obter o ID do projeto Apidog (opcional)

Abra o projeto de destino no Apidog

Clique em Configurações do projeto na barra lateral esquerda

Navegue até Configurações básicas

Copie o ID do projeto para substituir <project-id> na configuração

Copiar a configuração MCP dentro do projeto

Você pode abrir qualquer API e usar a entrada Codificação com IA para copiar sua configuração MCP diretamente.

Configuração do MCP no Cursor

Abrir as configurações do MCP

Abra o editor Cursor

Clique no ícone de configurações (canto superior direito)

Selecione MCP no menu à esquerda

Clique em + Adicionar novo servidor MCP global

Adicionar configuração

Cole a configuração a seguir no arquivo mcp.json aberto. Substitua <access-token> e <project-id> pelos seus valores reais:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project-id=<project-id>"
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Verificar configuração

Teste a conexão perguntando à IA (no modo Agent):

Please fetch API specification via MCP and tell me how many endpoints exist in the project

Se a IA retornar as informações de API do seu projeto Apidog, a conexão foi bem-sucedida.

Observações importantes

Substitua <access-token> e <project-id> pelo seu token de acesso pessoal à API do Apidog e pelo ID do projeto.

Como trabalhar com vários projetos

Para trabalhar com especificações de API de vários projetos, adicione várias configurações de MCP Server ao arquivo de configuração. Cada projeto deve ter seu próprio <project-id> exclusivo.

Para maior clareza, nomeie cada MCP Server seguindo o formato "[Nome do projeto] Especificação de API".

Melhores práticas de segurança

Se a sua equipe sincronizar o arquivo de configuração MCP com um repositório de código:

Remova a linha "APIDOG_ACCESS_TOKEN": "<access-token>" da configuração

Configure APIDOG_ACCESS_TOKEN como uma variável de ambiente na máquina de cada membro da equipe

Isso evita vazamento de tokens no controle de versão.

Implantação on-premise

Para implantações on-premise, inclua o endereço da API do seu servidor na configuração MCP da IDE:

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project-id=<project-id>",
        "--apidog-api-base-url=<your-server-url>"
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

Substitua <your-server-url> pelo endereço da API do seu servidor on-premise (começando com http:// ou https://). Garanta acesso de rede a www.npmjs.com.

Outras fontes de dados

Conectar documentação de API online publicada pelo Apidog à IA

Conectar arquivos OpenAPI à IA

Perguntas frequentes

Estou usando o Apidog Europe. Preciso de alguma configuração especial ao iniciar o servidor MCP?

Sim. Se você estiver usando o Apidog Europe, será necessário adicionar o parâmetro --apidog-api-base-url e defini-lo como o endpoint de API da UE.

Abaixo está um exemplo de configuração:

"Pet Store- Apidog": {
  "command": "npx",
  "args": [
    "-y",
    "apidog-mcp-server@latest",
    "--project-id=xxx",
    "--apidog-api-base-url=https://api.eu.apidog.com"
  ],
  "env": {
    "APIDOG_ACCESS_TOKEN": "xxx"
  }
}

Problemas de configuração no Windows

Problemas de versão do Node.js

Como permitir que a IA leia os dados mais recentes de especificações de API atualizadas?

Conectar projeto Apidog à IA

Pré-requisitos#

Obtenção das credenciais necessárias#

Configuração do MCP no Cursor#

Observações importantes#

Como trabalhar com vários projetos#

Melhores práticas de segurança#

Implantação on-premise#

Outras fontes de dados#

Perguntas frequentes#

Pré-requisitos

Obtenção das credenciais necessárias

Configuração do MCP no Cursor

Observações importantes

Como trabalhar com vários projetos

Melhores práticas de segurança

Implantação on-premise

Outras fontes de dados

Perguntas frequentes