关于 OpenAPI MCP Server
OpenAPI MCP Server 根据 OpenAPI 文档和基础 URL,将配置的 REST API 提供给大模型使用。它支持 GET、PUT、POST 和 PATCH 请求,并可选配置请求头及操作白名单或黑名单。
主要功能
- 01基于 OpenAPI 访问 REST API
- 02支持 GET、PUT、POST、PATCH
- 03可选设置请求头
- 04操作白名单与黑名单
适用场景
- 01让大模型调用配置的 REST API
- 02限制可用的 API 操作
- 03通过代理设置转发请求
MCP 相关
该 MCP 服务根据 OpenAPI 文档和 API 基础 URL,向 MCP 客户端提供配置的 REST API 操作。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
暂未收录安装方式
我们还没有获取到这个服务的安装包或远程地址,请按项目 README 中的说明安装。
工具
还没有获取到工具列表
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
OpenAPI MCP Server
概述
- 此项目将安装
MCP - Model Context Protocol Server,为大模型提供已配置的 REST API 作为上下文。 - 使用此项目,可以让大模型与 RestAPI 交互,并通过大模型提示词发起 REST API 调用。
- 目前支持 HTTP API 调用:
GET/PUT/POST/PATCH。
安装
- 安装软件包
pip install openapi_mcp_server - 在某个文件夹中创建 .env,并至少设置
OPENAPI_SPEC_PATH和API_BASE_URL。可在此处获取示例文件。 - 在上述文件夹中运行
uv run openapi_mcp_server,测试openapi_mcp_server服务。
Claude Desktop
- Claude Desktop 的配置详情
{ "mcpServers": { "openapi_mcp_server":{ "command": "uv", "args": ["run","openapi_mcp_server"] "env": { "DEBUG":"1", "API_BASE_URL":"https://petstore.swagger.io/v2", "OPENAPI_SPEC_PATH":"https://petstore.swagger.io/v2/swagger.json", "API_HEADERS":"Accept:application/json", "API_WHITE_LIST":"addPet,updatePet,findPetsByStatus" } } } }
配置
- 可用环境变量列表
DEBUG:启用调试日志(可选,默认值为 False)OPENAPI_SPEC_PATH:OpenAPI 文档的路径。(必填)API_BASE_URL:API 请求的基础 URL。(必填)API_HEADERS:API 请求中包含的标头(可选)API_WHITE_LIST:白名单 operationId,列表格式为 ["operationId1", "operationId2"](可选)API_BLACK_LIST:黑名单 operationId,列表格式为 ["operationId3", "operationId4"](可选)HTTP_PROXY:HTTP 代理详情(可选)HTTPS_PROXY:HTTPS 代理详情(可选)NO_PROXY:不使用代理的详情(可选)
贡献
欢迎贡献。
请随时提交 Pull Request。
许可证
此项目根据 MIT 许可证的条款授权。
Github 星标
附录
UV
mkdir -m777 openapi_mcp_server
cd openapi_mcp_server
uv init
uv add mcp[cli] pydantic python-dotenv requests
uv add --dev twine setuptools
uv sync
uv run openapi_mcp_server
uv build
pip install --force-reinstall --no-deps .\dist\openapi_mcp_server-*fileversion*.whl
export TWINE_USERNAME="rahgadda"
export TWINE_USERNAME="<<API Key>>"
uv run twine upload --verbose dist/*
参考
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。