Skip to main content

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

功能

测试

测试

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.3.tar.gz (3.6 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.3-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openapi2mcpserver-0.1.3.tar.gz
Algorithm Hash digest
SHA256 353d7022672d8ac20133a4fafa911421e2eb81fd80d542f07e837313d82e7a93
MD5 a594dd0fc2cb7897d14723d1a6b33f80
BLAKE2b-256 f261badf5d8a6e2c14270967a1636b6afe7c6d863550b510e3ddec0ff41528b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi2mcpserver-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b0f0a54795cd1b8a3b8004347ca054ea331387e99ecffd8a2566ebf7c7cebe76
MD5 39915068e42b53c931c5a057bd1f6824
BLAKE2b-256 8e18e7ac233abdd26e35b3b88002e25b2f7a20a807ede97398a7f3b9ef379621

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 files

0.1.2

2 files

0.1.0

2 files

Supported by

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