使用说明
基本能力
产品定位
OAS-MCP是一个用于从OpenAPI规范自动生成MCP服务器和工具的开发工具,旨在简化API开发和集成流程。
核心功能
- 从OpenAPI规范自动生成Go客户端代码
- 构建基于生成代码的MCP服务器
- 将每个API端点作为MCP工具提供
- 支持SSE(Server-Sent Events)实现实时通信
适用场景
- 需要快速从OpenAPI规范生成API客户端的场景
- 需要构建实时通信API的场景
- 需要自动化API工具生成的开发流程
工具列表
- OpenAPI到Go代码生成工具:将OpenAPI规范转换为可用的Go客户端代码
- MCP服务器:基于生成的代码提供API服务
- MCP工具:将每个API端点作为独立的工具提供
常见问题解答
- 依赖问题:确保Go版本在1.24以上
- 生成代码问题:检查OpenAPI规范的完整性和正确性
使用教程
使用依赖
- Go 1.24以上
安装教程
# 克隆仓库
git clone https://github.com/nonchan7720/oas-mcp.git
cd oas-mcp
# 安装依赖
go mod download
使用方法
# 从OpenAPI规范生成客户端代码
go run cmd/main.go -path=./api/openapi.yaml -output=./pkg/client
# 或者使用go:generate
go generate ./...
调试方式
- 检查生成的Go代码是否符合预期
- 验证MCP服务器是否能正确响应API请求
- 使用SSE测试实时通信功能
