OpenAPI MCP Server

OpenAPI MCP Server

site icon
2025.03.17 5
PythonREST API 集成LLM 扩展开发效率
OpenAPI MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在为大型语言模型 (LLM) 提供配置好的 REST API 上下文,使 LLM 能够通过提示词与 REST API 进行交互。该服务支持 HTTP API 调用,包括 GET、PUT、POST 和 PATCH 方法。
View on GitHub

Overview

基本能力

产品定位

OpenAPI MCP Server 的主要目标是为 LLM 提供 REST API 的上下文,使其能够通过自然语言提示调用 API,从而扩展 LLM 的功能。

核心功能

  1. REST API 集成:支持 HTTP API 调用(GET/PUT/POST/PATCH)。
  2. OpenAPI 规范支持:通过 OpenAPI 文档配置 API 上下文。
  3. 白名单/黑名单:支持通过 API_WHITE_LISTAPI_BLACK_LIST 限制可调用的 API。
  4. 代理支持:支持 HTTP/HTTPS 代理配置。
  5. 调试模式:通过 DEBUG 环境变量启用调试日志。

适用场景

  1. LLM 扩展功能:使 LLM 能够通过自然语言调用 REST API。
  2. API 测试:快速测试和验证 REST API 的功能。
  3. 自动化工作流:集成到自动化工具链中,实现 API 调用的自动化。

工具列表

  1. UV 工具链:用于初始化、构建和发布项目。
  2. Twine:用于发布 Python 包。
  3. Requests:用于处理 HTTP 请求。

常见问题解答

  1. 如何配置 API 上下文?:通过 OPENAPI_SPEC_PATHAPI_BASE_URL 环境变量配置。
  2. 如何限制 API 调用?:使用 API_WHITE_LISTAPI_BLACK_LIST 环境变量。
  3. 如何启用调试日志?:设置 DEBUG=1 环境变量。

使用教程

使用依赖

  1. 安装 Python 3.x。
  2. 安装 pip。

安装教程

  1. 安装包: bash pip install openapi_mcp_server
  2. 创建 .env 文件并配置 OPENAPI_SPEC_PATHAPI_BASE_URL
  3. 运行服务: bash uv run openapi_mcp_server

调试方式

  1. 启用调试模式: bash export DEBUG=1 uv run openapi_mcp_server
  2. 检查日志输出以排查问题。

许可证

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