Api Suggestion Server

🚀 API 建议服务器

API 建议服务器是一款基于 MCP 协议的实用工具，它能依据 OpenAPI 3.0 服务规范，为 Claude、GPT - 4 等 AI 模型提供 API 相关的上下文信息。该服务器可解析 YAML、JSON 格式或 URL 格式的 OpenAPI 规范，并通过 MCP 协议将 API 信息传递给 AI 模型，助力 AI 更好地理解和使用 API。

✨ 主要特性

• 多协议支持：支持 YAML、JSON 格式的 OpenAPI 文档，也支持以 URL 方式提供的文档。
• 智能建议：能根据输入的使用场景，给出最相关的 API 端点建议。
• 易于扩展：可轻松将新的 OpenAPI 服务规范添加到系统中。

📦 安装指南

1. 克隆项目仓库：

git clone [your-repository-url]
cd api-mcp-server

2. 安装依赖：

npm install

3. 启动服务器：

npm start

💻 使用示例

新服务规范的添加

1. 将 OpenAPI 服务规范文件（YAML 或 JSON 格式）放入 schemas 目录。
2. 在 server.config.ts 文件中新增相应的服务配置。

MCP 协议支持

AI 模型可通过调用以下工具与服务器交互：

suggest_api 工具

功能：提供与指定用途相关的 API 端点建议。

输入参数：

• purpose：使用 API 的目的描述（字符串）

输出结果：

• 相关 API 端点列表（包含服务名称、路径、请求方法和描述信息）

示例用法：

{
  "name": "suggest_api",
  "arguments": {
    "purpose": "用户信息获取"
  }
}

返回示例：

{
  "toolResult": [
    {
      "service": "示例 API",
      "path": "/users/{userId}",
      "method": "GET",
      "description": "根据 ID 获取指定用户信息"
    },
    {
      "service": "示例 API", 
      "path": "/users",
      "method": "GET",
      "description": "获取所有用户列表"  
    }
  ]
}

📚 详细文档

配置

编辑 server.config.ts 文件以添加新的服务配置。

开发指南

构建项目

npm run build

测试

1. 执行所有测试：

npm test

2. 启用观察模式运行测试（方便开发）：

npm run test:watch

3. 生成覆盖率报告：

npm run test:coverage

目录结构

api-mcp-server/
├── src/
│   ├── index.ts        # 主服务器代码
│   ├── utils.ts        # 工具函数
│   ├── types.ts        # 类型定义
│   └── tests/          # 测试文件
├── schemas/            # OpenAPI 服务规范文件
├── server.config.ts    # 服务器配置
├── tsconfig.json       # TypeScript 配置
└── package.json        # 项目依赖管理

📄 许可证

MIT License

🤝 贡献指南

欢迎提交问题和贡献代码！