Ligar o Projeto Apidog à IA

O Apidog MCP Server permite que a IA se ligue 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 tem:

Node.js (versão 18 ou posterior, de preferência a versão LTS mais recente)

Um IDE compatível com MCP:

Cursor

VS Code + plugin Cline

Outros editores com suporte para MCP

Obter as Credenciais Necessárias

Gerar Token de Acesso à API

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

Selecione Definiçõ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 Definições do Projeto na barra lateral esquerda

Navegue até Definições Básicas

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

Copiar a Configuração MCP dentro do Projeto

Pode abrir qualquer API e utilizar a entrada Codificação com IA para copiar diretamente a respetiva configuração MCP.

Copiar a configuração MCP a partir do Apidog

Configurar o MCP no Cursor

Abrir as Definições do MCP

Abra o editor Cursor

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

Selecione MCP no menu à esquerda

Clique em + Add new global MCP server

Adicionar Configuração

Cole a seguinte configuração no ficheiro 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 ligação pedindo à IA (no modo Agent):

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

Se a IA devolver as informações da API do seu projeto Apidog, a ligação foi estabelecida com sucesso.

Notas Importantes

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

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 ficheiro de configuração. Cada projeto deve ter o seu próprio <project-id> exclusivo.

Para maior clareza, atribua um nome a cada MCP Server seguindo o formato "[Nome do Projeto] Especificação de API".

Boas Práticas de Segurança

Se a sua equipa sincronizar o ficheiro 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 equipa

Isto evita a fuga de tokens no controlo de versões.

Implementação On-Premise

Para implementações on-premise, inclua o endereço da API do seu servidor na configuração MCP do 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 (a começar por http:// ou https://). Certifique-se de que existe acesso de rede a www.npmjs.com.

Outras Fontes de Dados

Ligar Documentação de API Online Publicada pelo Apidog à IA

Ligar Ficheiros OpenAPI à IA

Perguntas Frequentes

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

Sim. Se estiver a utilizar o Apidog Europe, tem de adicionar o parâmetro --apidog-api-base-url e defini-lo para o endpoint da API da UE.

Segue abaixo 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 com a Versão do Node.js

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

Ligar o Projeto Apidog à IA

Pré-requisitos#

Obter as Credenciais Necessárias#

Configurar o MCP no Cursor#

Notas Importantes#

Trabalhar com Vários Projetos#

Boas Práticas de Segurança#

Implementação On-Premise#

Outras Fontes de Dados#

Perguntas Frequentes#

Pré-requisitos

Obter as Credenciais Necessárias

Configurar o MCP no Cursor

Notas Importantes

Trabalhar com Vários Projetos

Boas Práticas de Segurança

Implementação On-Premise

Outras Fontes de Dados

Perguntas Frequentes