Integrations
Uses environment variables for configuration management, allowing users to specify API endpoints, credentials, and other settings through a .env file.
Leverages Pydantic for data validation and parsing of API request/response models defined in OpenAPI specifications.
Enables interaction with RESTful APIs defined in Swagger/OpenAPI specifications, supporting GET, PUT, POST, and PATCH operations. The example demonstrates integration with the Swagger Petstore API, including operations like addPet, updatePet, and findPetsByStatus.
OpenAPI MCP 服务器
概述
- 该项目将安装
MCP - Model Context Protocol Server
,它提供配置的 REST API 作为 LLM 的上下文。 - 使用此功能,我们可以使 LLM 与 RestAPI 交互并使用 LLM 提示执行 REST API 调用。
- 目前我们支持HTTP API调用的
GET/PUT/POST/PATCH
。
安装
- 安装包Copy
- 在文件夹中创建 .env 文件,并设置
OPENAPI_SPEC_PATH
和API_BASE_URL
的最小值。示例文件可在此处获取。 - 使用上述文件夹中的
uv run openapi_mcp_server
测试openapi_mcp_server
服务器。
克劳德桌面
- Claud Desktop 的配置详情Copy
配置
- 可用环境变量列表
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
:无代理详细信息(可选)
贡献
欢迎投稿。
请随时提交拉取请求。
执照
该项目是根据 MIT 许可条款授权的。
Github 星标
附录
紫外线
Copy
参考
This server cannot be installed
模型上下文协议服务器使 LLM 能够通过自然语言提示与 REST API 调用交互并执行 REST API 调用,支持对配置的 API 执行 GET/PUT/POST/PATCH 操作。