Conectar archivos OpenAPI a la IA

Apidog MCP Server puede leer directamente archivos Swagger u OpenAPI Specification (OAS), lo que permite que los asistentes de IA trabajen con especificaciones de API independientemente de los proyectos de Apidog o de la documentación en línea.

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

Un archivo Swagger/OpenAPI (URL o ruta local)

Preparación de su archivo OpenAPI

Asegúrese de contar con una de las siguientes opciones:

URL remota: Un archivo OpenAPI accesible públicamente (por ejemplo, https://petstore.swagger.io/v2/swagger.json)

Ruta de archivo local: Un archivo OpenAPI en su equipo (por ejemplo, ~/data/petstore/swagger.json)

Formatos compatibles: JSON o YAML

Descripción general de la configuración

La configuración básica de MCP para archivos OpenAPI:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

Reemplace <oas-url-or-path> por:

Una URL remota (por ejemplo, https://petstore.swagger.io/v2/swagger.json)

Una ruta de archivo local (por ejemplo, ~/data/petstore/swagger.json)

Configuración de MCP en Cursor

Abrir la configuración de MCP

Abra el editor Cursor

Haga clic en el icono de configuración (parte superior 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

En el archivo mcp.json abierto, agregue la siguiente configuración. Reemplace https://petstore.swagger.io/v2/swagger.json por la ruta o URL real de su archivo OpenAPI:

macOS / Linux

Windows

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}

Verificar la 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 desde su archivo OpenAPI, la conexión se ha realizado correctamente.

Notas importantes

Trabajar con varios archivos OpenAPI

Para utilizar varios archivos de especificación OpenAPI, agregue varios MCP Servers en el archivo de configuración, cada uno con un parámetro --oas diferente.

Ejemplo:

{
  "mcpServers": {
    "Petstore API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    },
    "Local API": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=~/data/my-api/openapi.yaml"
      ]
    }
  }
}

Requisitos de ruta de archivo y URL

Rutas de archivos locales: Asegúrese de que la ruta sea correcta y de que el archivo exista

URL: Asegúrese de que sean accesibles públicamente y devuelvan un archivo de especificación OpenAPI válido

Consideraciones de rendimiento

Si su archivo OpenAPI es grande o contiene estructuras de datos complejas, el servidor MCP puede tardar más en procesarlo.

Implementación local

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

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

Reemplace <your-server-url> por la dirección de API de su servidor local (que comience con 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 de un proyecto de Apidog a la IA

Conectar la documentación de API en línea publicada por Apidog a la IA

Preguntas frecuentes

Problemas de configuración en Windows

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

{
  "mcpServers": {
    "API specification": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--oas=<oas-url-or-path>"
      ]
    }
  }
}

Problemas con la versión de Node.js

Conectar archivos OpenAPI a la IA

Requisitos previos#

Preparación de su archivo OpenAPI#

Descripción general de la configuración#

Configuración de MCP en Cursor#

Notas importantes#

Trabajar con varios archivos OpenAPI#

Requisitos de ruta de archivo y URL#

Consideraciones de rendimiento#

Implementación local#

Otras fuentes de datos#

Preguntas frecuentes#