OpenAPI to MCP Server

OpenAPI to MCP Server

Este é um servidor de conversão OpenAPI, que oferece os seguintes recursos:

• Converte especificações OpenAPI em serviços MCP
• Suporta passagem de cabeçalhos HTTP
• Suporta o uso local do MCP via stdio padrão, e também suporta a implantação via Docker como servidor MCP para uso através de HTTP streamable

Configuração de uso do MCP

Este projeto suporta a configuração do servidor MCP através de vários clientes, para integração com diversos IDEs ou ferramentas. Abaixo estão alguns exemplos de configuração para clientes comuns:

Windsurf / Cursor / Claude

Para clientes baseados no framework Windsurf (como Cursor e Claude), você pode configurar o servidor MCP no arquivo ~/.codeium/windsurf/mcp_config.json. Abaixo está um exemplo de configuração:

{
  "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"
      }
    }
  }
}

Substitua BASE_URL e OPEN_API_DOC_JSON_URL pelo endereço real do seu servidor OpenAPI e pela URL JSON do documento.

Cline

Para o cliente Cline, você pode adicionar uma configuração semelhante de servidor MCP no arquivo de configuração dele. Consulte a documentação oficial do Cline para obter detalhes específicos de configuração. Normalmente, você precisa especificar o nome do servidor, comando, argumentos e variáveis de ambiente.

// 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"
      }
    }
  }
}

Substitua os espaços reservados no exemplo pelo endereço real do seu servidor OpenAPI e pela URL JSON do documento, e ajuste conforme o formato de configuração específico do Cline.

Instalação

1. Clone o repositório
2. Instale as dependências: pip install -r requirements.txt
3. Configure as variáveis de ambiente (veja abaixo)

Configuração

Crie o arquivo .env na raiz do projeto, contendo as seguintes variáveis de ambiente:

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

Execução

Instalar e executar com uvx (recomendado)

uvx --from openapi2mcpserver

Implantação via 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

Observações

1. Substitua "xxx.xx.xx.xxx" pelo IP da sua máquina local
2. Configure as variáveis de ambiente conforme a necessidade real