API Suggestion Server
2025.04.05
0
TypeScriptAPI推荐开发辅助开发效率
API Suggestion Server 是一个基于 OpenAPI 规范的 MCP（Model Context Protocol）服务器，旨在根据用户的需求和目的，从可用的 API 端点中推荐最合适的选项。该服务器通过 MCP 协议与 AI 模型协同工作，提供智能化的 API 端点建议服务。
View on GitHub
Overview
基本能力
产品定位
API Suggestion Server 是一个智能 API 推荐服务，帮助开发者快速找到适合其需求的 API 端点。
核心功能
- 从多个 OpenAPI 规范（YAML 或 JSON 格式）收集 API 端点信息
- 根据用户目的推荐相关 API 端点
- 通过 MCP 协议与 AI 模型协同工作
适用场景
- 开发者需要快速找到适合特定功能的 API 时
- 在大型 API 集合中导航和发现相关端点时
- 构建 AI 辅助的 API 开发工具时
工具列表
- suggest_api: 根据指定用途推荐合适的 API 端点
- 输入参数:
purpose(API 使用目的的文本描述) - 输出: 相关 API 端点列表(包含服务名、路径、方法和描述)
常见问题解答
- 支持哪些 OpenAPI 格式?
- YAML 或 JSON 格式的 OpenAPI 规范
-
本地文件或远程 URL 均可
-
如何添加新的 API 规范?
- 将 OpenAPI 文件放入 schemas 目录
- 或在 server.config.ts 中配置新的服务
使用教程
使用依赖
- Node.js 18+
- npm 或 yarn
安装教程
# 克隆仓库
git clone https://github.com/yourusername/api-mcp-server.git
cd api-mcp-server
# 安装依赖
npm install
调试方式
- 启动服务器:
npm start
- 运行测试:
# 运行所有测试
npm test
# 开发时监视模式
npm run test:watch
# 生成覆盖率报告
npm run test:coverage