MCP OpenAPI Explorer
2025.05.01
0
GoAPI 分析OpenAPI 规范解析LLM 上下文提供开发效率
MCP OpenAPI Explorer 是一个基于 Model Context Protocol (MCP) 的服务，主要用于分析和提供与 OpenAPI 规范交互的上下文信息。它能够从多种来源加载 OpenAPI 规范，解析并提供关于 API 端点的详细信息，支持通过 stdin/stdout 进行通信，为大型语言模型（LLM）提供智能的 API 交互上下文。
View on GitHub
Overview
基本能力
产品定位
MCP OpenAPI Explorer 是一个专门用于分析和提供 OpenAPI 规范交互上下文的工具，旨在帮助开发者和 LLM 更高效地理解和操作 API。
核心功能
- 从多种来源（GitHub、本地文件、HTTP URL）加载 OpenAPI 规范
- 解析并提供关于 API 端点的全面上下文信息
- 支持通过 stdin/stdout 进行 Model Context Protocol (MCP) 通信
- 为 LLM 提供智能的 API 交互上下文
- 支持 JSON 和 YAML 格式的 OpenAPI 规范
- 使用 Cobra CLI 构建，便于命令行使用
- 使用 Zap 进行结构化日志记录
适用场景
- 开发者在开发过程中需要快速了解和使用 API
- LLM 需要获取 API 的详细上下文信息以回答用户查询
- 团队协作中需要共享和解析 API 规范
工具列表
get_api_info: 获取关于 API 端点的详细信息load_api_spec: 从 URL 或文件路径加载 OpenAPI 规范list_api_specs: 列出所有已加载的 OpenAPI 规范delete_api_spec: 删除已加载的 OpenAPI 规范refresh_api_spec: 刷新一个或多个 OpenAPI 规范
常见问题解答
- 如何加载私有 GitHub 仓库的 OpenAPI 规范？ 需要创建 GitHub 个人访问令牌（PAT）并配置到环境变量或配置文件中。
- 如何与 MCP 客户端集成？ 在 MCP 客户端配置文件中添加 MCP OpenAPI Explorer 的路径和参数。
使用教程
使用依赖
- Go 1.24.2 或更高版本
- Docker（可选）
安装教程
- 克隆仓库：
git clone https://github.com/krypticlabs/mcp-openapi-explorer.git
cd mcp-openapi-explorer
- 安装依赖：
go mod download
- 构建：
go build
调试方式
- 启动服务器：
./mcp-openapi-explorer serve
- 使用工具进行调试，例如获取 API 信息：
echo '{"jsonrpc":"2.0","id":5,"method":"tools/call","params":{"name":"get_api_info","arguments":{"query":"How do I find pets by status?"}}}' | ./mcp-openapi-explorer serve
- 使用 Docker 运行：
docker build -t mcp-openapi-explorer .
docker run -i mcp-openapi-explorer serve < your-jsonrpc-request.json