MCP-OpenAPI

MCP-OpenAPI

site icon
2025.02.24 5
PythonAPI 工具开发工具开发效率
MCP-OpenAPI 是一个基于 Model Context Protocol (MCP) 的服务,它通过 OpenAPI 规范将 HTTP 方法暴露为工具。该服务允许用户通过运行多个实例来暴露多个 OpenAPI 规范,支持 OpenAPI 3.0 和 3.1 规范,并能处理 JSON 和 YAML 格式的规范。MCP-OpenAPI 主要用于开发环境,帮助开发者快速集成和测试 API。
View on GitHub

Overview

基本能力

产品定位

MCP-OpenAPI 是一个开发工具,旨在通过 OpenAPI 规范将 HTTP 方法暴露为工具,便于开发者在开发过程中快速集成和测试 API。

核心功能

  • 支持 OpenAPI 3.0 和 3.1 规范
  • 支持 JSON 和 YAML 格式的 OpenAPI 规范
  • 通过 FastMCP 服务器注册和暴露工具
  • 支持通过环境变量配置 OpenAPI URL 和其他服务器参数

适用场景

  • 开发环境中的 API 集成和测试
  • 快速构建和测试基于 OpenAPI 规范的 API 工具
  • 多 API 规范的并行测试

工具列表

  • uvx mcp-openapi:启动 MCP-OpenAPI 服务器的命令
  • --openapi-url:指定 OpenAPI 规范的 URL
  • --fastmcp-sse-host--fastmcp-sse-port:配置 SSE 服务器的主机和端口
  • --fastmcp-debug--fastmcp-log-level:配置调试模式和日志级别

常见问题解答

  • 支持的 OpenAPI/Swagger 版本:支持 OpenAPI 3.0 和 3.1,不支持 Swagger 2.0
  • 如何处理 API 认证:可以通过 --auth-token 参数提供全局认证令牌

使用教程

使用依赖

  • 需要安装 Python 和 uvx 工具

安装教程

  1. 通过 PyPI 安装 mcp-openapibash pip install mcp-openapi
  2. 启动服务器: bash uvx mcp-openapi --openapi-url https://httpbin.org/spec.json stdio

调试方式

  1. 启用调试模式: bash uvx mcp-openapi --openapi-url https://httpbin.org/spec.json --fastmcp-debug stdio
  2. 设置日志级别: bash uvx mcp-openapi --openapi-url https://httpbin.org/spec.json --fastmcp-log-level DEBUG stdio

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。