Swagger MCP

Un servidor MCP que se conecta a una especificación Swagger y ayuda a una IA a construir todos los modelos necesarios para generar un servidor MCP para ese servicio.

Características

Descarga una especificación Swagger y la almacena localmente para una referencia más rápida.
Devuelve una lista de todos los puntos finales y sus métodos HTTP y descripciones.
Devuelve una lista de todos los modelos
Devuelve un modelo
Devuelve el servicio para conectarse al punto final.
Devuelve definiciones de funciones MCP
Genera definiciones completas de herramientas MCP con información completa del esquema
Incluye instrucciones específicas de IA en las descripciones de las herramientas.

Prerrequisitos

Node.js (v14 o superior)
npm o hilo

Instalación

Clonar el repositorio:

git clone https://github.com/readingdancer/swagger-mcp.git
cd swagger-mcp

Instalar dependencias:

npm install

Cree un archivo .env basado en el archivo .env.example :

cp .env.example .env

Actualice el archivo .env .

Configuración

Edite el archivo .env para configurar la aplicación:

PORT : El puerto en el que se ejecutará el servidor (predeterminado: 3000)
NODE_ENV : El entorno (desarrollo, producción, prueba)
LOG_LEVEL : Nivel de registro (información, error, depuración)

Uso

Construyendo la aplicación

Construir la aplicación:

npm run build

Esto compilará el código TypeScript listo para usarse como un servidor MCP

Ejecutándose como un servidor MCP

Para ejecutarlo como servidor MCP para la integración con Cursor y otras aplicaciones:

node build/index.js

Uso del inspector MCP

Para ejecutar el inspector MCP para depuración:

npm run inspector

Agregar al cursor

Para agregar este servidor MCP a Cursor:

Abra Configuración del cursor > Funciones > MCP
Haga clic en "+ Agregar nuevo servidor MCP"
Ingrese un nombre para el servidor (por ejemplo, "Swagger MCP")
Seleccione "stdio" como tipo de transporte
Ingrese el comando para ejecutar el servidor: node path/to/swagger-mcp/build/index.js y luego, si es necesario, agregue los argumentos de la línea de comando como se mencionó anteriormente.
Haga clic en "Agregar"

Las herramientas Swagger MCP ahora estarán disponibles para el Agente de Cursor en Composer.

Herramientas Swagger MCP disponibles

Las siguientes herramientas están disponibles a través del servidor MCP:

getSwaggerDefinition : descarga una definición de Swagger desde una URL
listEndpoints : enumera todos los puntos finales de la definición de Swagger
listEndpointModels : enumera todos los modelos utilizados por un punto final específico
generateModelCode : genera código TypeScript para un modelo
generateEndpointToolCode : genera código TypeScript para una definición de herramienta MCP

Avisos Swagger MCP disponibles

El servidor también proporciona indicaciones MCP que guían a los asistentes de IA a través de flujos de trabajo comunes:

add-endpoint : una guía paso a paso para agregar un nuevo punto final utilizando las herramientas Swagger MCP

Para utilizar un aviso, los clientes pueden realizar una solicitud prompts/get con el nombre del aviso y argumentos opcionales:

{
  "method": "prompts/get",
  "params": {
    "name": "add-endpoint",
    "arguments": {
      "swaggerUrl": "https://petstore.swagger.io/v2/swagger.json",
      "endpointPath": "/pets/{id}",
      "httpMethod": "GET"
    }
  }
}

El mensaje devolverá una serie de mensajes que guiarán al asistente de IA a través del proceso exacto necesario para agregar un nuevo punto final.

Configuración de su nuevo proyecto

Primero, pídale al agente que obtenga el archivo Swagger, asegúrese de darle la URL del archivo Swagger, o al menos una forma de encontrarlo para usted, esto descargará el archivo y lo guardará localmente con un nombre de archivo en hash, este nombre de archivo se agregará automáticamente a un archivo de configuración .swagger-mcp en la raíz de su solución actual.

Archivo de configuración .swagger-mcp generado automáticamente

SWAGGER_FILENAME = TheFilenameOfTheLocallyStoredSwaggerFile

Este simple archivo de configuración asocia su proyecto actual con una API Swagger específica; podremos usarlo para almacenar más detalles en el futuro.

Una vez configurado, el MCP podrá encontrar su definición de Swagger y asociarla con su solución actual, reduciendo la cantidad de llamadas API necesarias para obtener el proyecto y las tareas relacionadas con la solución en la que está trabajando.

Generador de código de herramientas MCP mejorado

Se ha mejorado el generador de código de herramientas MCP para proporcionar definiciones de herramientas más completas y utilizables:

Mejoras clave

Información de esquema completa : el generador ahora incluye información de esquema completa para todos los modelos, incluidos los objetos anidados, directamente en el inputSchema.
Mejor denominación de parámetros : los nombres de parámetros ahora son más semánticos y evitan caracteres problemáticos como los puntos (por ejemplo, taskRequest en lugar de task.Request ).
Nombres de herramientas semánticas : los nombres de herramientas ahora son más descriptivos y siguen convenciones de nomenclatura consistentes basadas en el método HTTP y la ruta del recurso.
Compatibilidad con archivos Swagger YAML : el generador ahora admite archivos de definición Swagger JSON y YAML.
Documentación mejorada : las definiciones de herramientas generadas incluyen descripciones completas de todos los parámetros y propiedades.
Sin dependencias externas : el código generado no requiere la importación de archivos de modelos externos, lo que lo hace más autónomo y más fácil de usar.
Instrucciones específicas de IA : las descripciones de las herramientas ahora incluyen instrucciones especiales para los agentes de IA, lo que les ayuda a comprender cómo usar las herramientas de manera eficaz.

Ejemplo de uso

Para generar una definición de herramienta MCP para un punto final:

import generateEndpointToolCode from './services/generateEndpointToolCode.js';

const toolCode = await generateEndpointToolCode({
  path: '/pets',
  method: 'POST',
  swaggerFilePath: './petstore.json',
  singularizeResourceNames: true
});

console.log(toolCode);

Esto generará una definición completa de la herramienta MCP con información de esquema completa para el punto final POST /pets.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.

Indicaciones de MCP para asistentes de IA

Para ayudar a los asistentes de IA a usar las herramientas Swagger MCP eficazmente, hemos creado una colección de indicaciones que los guían en tareas comunes. Estas indicaciones proporcionan instrucciones paso a paso para procesos como añadir nuevos puntos finales, usar modelos generados y más.

Consulte el archivo PROMPTS.md para ver la colección completa de indicaciones.

Ejemplo de caso de uso: cuando le pides a un asistente de IA que agregue un nuevo punto final a tu proyecto, puedes hacer referencia al mensaje "Agregar un nuevo punto final" para asegurarte de que el asistente siga el proceso correcto en el orden correcto.

Integrations