Skip to main content

OpenAPI to MCP服务器,提供OpenAPI转换为MCP功能

Project description

OpenAPI to MCP Server

这是一个基于FastMCP的OpenAPI转换服务器,提供了以下功能:

  • OpenAPI规范解析
  • 自动生成MCP工具
  • API调用封装

MCP 配置

本项目支持通过多种客户端配置 MCP 服务器,以便与各种 IDE 或工具集成。以下是一些常见客户端的配置示例:

Windsurf / Cursor / Claude

对于基于 Windsurf 框架的客户端(如 Cursor 和 Claude),您可以在 ~/.codeium/windsurf/mcp_config.json 文件中配置 MCP 服务器。以下是一个示例配置:

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

请将 BASE_URL, OPEN_API_DOC_JSON_URL 替换为您的实际 OpenAPI 服务器地址和文档 JSON URL。

Cline

对于 Cline 客户端,您可以在其配置文件中添加类似的 MCP 服务器配置。具体的配置方式请参考 Cline 的官方文档。通常,您需要指定服务器的名称、命令、参数和环境变量。

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

请将示例中的占位符替换为您的实际 OpenAPI 服务器地址和文档 JSON URL,并根据 Cline 的具体配置格式进行调整。

安装

  1. 克隆仓库
  2. 安装依赖:pip install -r requirements.txt
  3. 配置环境变量(参见下文)

配置

在项目根目录创建.env文件,包含以下环境变量:

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

运行

使用uvx安装并运行(推荐)

uvx --from openapi2mcpserver

功能

测试

测试

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi2mcpserver-0.1.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi2mcpserver-0.1.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file openapi2mcpserver-0.1.0.tar.gz.

File metadata

  • Download URL: openapi2mcpserver-0.1.0.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for openapi2mcpserver-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a0cefe0a7914909249ce3122112933a08e79481766054274a2e360ca9a0f8434
MD5 81edce5f876e20013bb97213db1b78e0
BLAKE2b-256 4e4de450f6c102b4e183169ab0bbf121ea054e2e52f215f42bbad4e46917c024

See more details on using hashes here.

File details

Details for the file openapi2mcpserver-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi2mcpserver-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1bfd716a430665324e6124174ec25b0198a4a66b73cf3e878d5baf9bd131c1f1
MD5 ee545b6803c139fbba2c23037716a902
BLAKE2b-256 e597a174e724f760a45bf55facf201e6f4256c57c0e87caf8c8511b679ac24a1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page