OpenAPI to MCP Server

OpenAPI to MCP Server

Este es un servidor de conversión OpenAPI que proporciona las siguientes funciones:

• Convierte especificaciones OpenAPI en servicios MCP
• Soporta la transmisión de encabezados HTTP
• Soporta el uso local de MCP mediante stdio, y también se puede implementar como servidor MCP mediante Docker para su uso a través de HTTP streamable

Configuración de uso de MCP

Este proyecto admite la configuración del servidor MCP a través de múltiples clientes para integrarse con varios IDE o herramientas. A continuación se muestran ejemplos de configuración para algunos clientes comunes:

Windsurf / Cursor / Claude

Para clientes basados en el framework Windsurf (como Cursor y Claude), puede configurar el servidor MCP en el archivo ~/.codeium/windsurf/mcp_config.json. A continuación se muestra un ejemplo de configuración:

{
  "mcpServers": {
    "openapi2mcpserver": {
      "disabled": false,
      "command": "uvx",
      "args": [
        "openapi2mcpserver"
      ],
      "env": {
        "BASE_URL": "your_openapi3.0_host",
        "OPEN_API_DOC_JSON_URL": "your_openapi3.0_host doc  json url"
      }
    }
  }
}

Reemplace BASE_URL y OPEN_API_DOC_JSON_URL con la dirección real de su servidor OpenAPI y la URL JSON del documento.

Cline

Para el cliente Cline, puede agregar una configuración similar del servidor MCP en su archivo de configuración. Consulte la documentación oficial de Cline para conocer el método de configuración específico. Generalmente, deberá especificar el nombre del servidor, el comando, los argumentos y las variables de entorno.

// Cline 配置文件示例 (具体格式请参考 Cline 文档)
{
  "mcpServers": {
    "openapi2mcpserver": {
      "command": "uvx",
      "args": [
        "openapi2mcpserver"
      ],
      "env": {
        "BASE_URL": "your_openapi3.0_host",
        "OPEN_API_DOC_JSON_URL": "your_openapi3.0_host doc  json url"
      }
    }
  }
}

Reemplace los marcadores de posición del ejemplo con la dirección real de su servidor OpenAPI y la URL JSON del documento, y ajuste según el formato de configuración específico de Cline.

Instalación

1. Clone el repositorio
2. Instale las dependencias: pip install -r requirements.txt
3. Configure las variables de entorno (consulte a continuación)

Configuración

Cree el archivo .env en el directorio raíz del proyecto, que contenga las siguientes variables de entorno:

BASE_URL=https://api.xxx.com
OPEN_API_DOC_JSON_URL=https://api.xxx.com/api/v3/api-docs/default

Ejecución

Instalar y ejecutar con uvx (recomendado)

uvx --from openapi2mcpserver

Método de implementación con Docker

docker run -d -p 9087:9087 -e BASE_URL=http://xxx.xx.xx.xxx:8044/xiaogj-ai-api -e OPEN_API_DOC_JSON_URL=http://xxx.xx.xx.xxx:8044/xiaogj-ai-api/v3/api-docs -e SERVER_NAME=OpenAPI2MCP-Docker-Server -e "ROUTE_MAPS=[{\"methods\":[\"GET\",\"POST\"],\"pattern\":\"^/tool/.*\"}]" jeweis/openapi2mcp:latest

Notas

1. "xxx.xx.xx.xxx" debe reemplazarse con la IP de su máquina local
2. Configure las variables de entorno según sus necesidades reales