Conectar documentación publicada a la IA

Apidog MCP Server permite que la IA se conecte y utilice documentación de API en línea publicada por Apidog, lo que permite que desarrolladores externos y asistentes de IA accedan sin problemas a la documentación pública de API.

Este método de configuración solo admite documentación en línea publicada públicamente. No admite documentación con configuración de contraseña o lista de permitidos.

Para documentación no pública, use en su lugar la fuente de datos de proyecto de Apidog.

Habilitar MCP para documentación en línea

Se requiere Apidog versión 2.7.2 o posterior.

Habilitar el servicio MCP

Vaya a su proyecto de Apidog

Vaya a Publicar documentación → Sitios de documentación publicados → Funciones compatibles con LLM

Habilite el servicio MCP

Habilitar el servicio MCP para documentación en línea

Obtener archivo de configuración

Después de habilitar MCP, el botón MCP aparecerá al acceder a su documentación en línea.

Haga clic en el botón para mostrar la guía de configuración y el archivo de configuración de MCP, que incluye automáticamente el site-id de su documentación. Copie esta configuración para la integración con el IDE.

Configurar el cliente MCP

Requisitos previos

Antes de configurar el cliente MCP, asegúrese de tener:

Node.js (versión 18 o posterior, preferiblemente la versión LTS más reciente)

Un IDE compatible con MCP:

Cursor

VS Code + plugin Cline

Otros editores compatibles con MCP

Configuración JSON de MCP copiada desde la documentación en línea de Apidog

Configurar MCP en Cursor

Abrir la configuración de MCP

Abra el editor Cursor

Haga clic en el icono de configuración (arriba a la derecha)

Seleccione MCP en el menú de la izquierda

Haga clic en + Add new global MCP server

Configuración del servidor MCP en Cursor

Agregar configuración

Pegue la configuración JSON de MCP copiada desde la documentación en línea en el archivo mcp.json abierto:

macOS / Linux

Windows

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Verificar configuración

Pruebe la conexión preguntando a la IA (en modo Agent):

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

Si la IA devuelve información correcta de la API, la conexión se ha realizado correctamente.

Notas importantes

Trabajar con varios sitios de documentación

Para trabajar con diferentes sitios de documentación de API, agregue varias configuraciones de MCP Server al archivo de configuración. Cada sitio de documentación debe tener su propio <site-id> único.

Implementación local

Para implementaciones locales, incluya la dirección de API de su servidor en la configuración MCP del IDE:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

Reemplace <your-server-url> por la dirección de API de su servidor local (que empiece por http:// o https://). Asegúrese de tener acceso de red a www.npmjs.com.

Otras fuentes de datos

Conectar la especificación de API dentro del proyecto de Apidog a la IA

Conectar archivos OpenAPI a la IA

Preguntas frecuentes

Problemas de configuración en Windows

Si la configuración estándar falla en Windows, use esta alternativa:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Problemas con la versión de Node.js

¿Cómo permitir que la IA lea los datos más recientes de la documentación de API actualizada?

Conectar documentación publicada a la IA

Habilitar MCP para documentación en línea#

Configurar el cliente MCP#

Requisitos previos#

Configurar MCP en Cursor#

Notas importantes#

Trabajar con varios sitios de documentación#

Implementación local#

Otras fuentes de datos#

Preguntas frecuentes#

Habilitar MCP para documentación en línea

Configurar el cliente MCP

Requisitos previos

Configurar MCP en Cursor

Notas importantes

Trabajar con varios sitios de documentación

Implementación local

Otras fuentes de datos

Preguntas frecuentes