IB API Documentation

IB API 文档

一个模型上下文协议（MCP）服务，提供从 Postman 集合中检索文档并生成 AI 操作的工具。

功能

• 列出并搜索 Postman 集合
• 浏览集合结构
• 获取详细的请求信息 | - 全面的响应示例处理： | - 列出可用的响应示例 | - 获取请求详情（侧重于请求信息） | - 获取详细的响应示例信息 | - 高效访问示例数据的工作流
• 根据 Postman 请求生成代码操作
• 可选集成多个 AI 框架
• TypeScript/JavaScript 代码生成

文档

• API 参考 - MCP 服务工具和数据结构的详细信息
• 配置指南 - MCP 服务设置和配置选项
• 提示词模板 - 使用这些工具的示例和模板
• 更新说明 - 如何更新 MCP 服务安装

安装

1. 克隆仓库：

git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc

2. 安装依赖：

npm install

3. 构建 MCP 服务：

npm run build

4. 按照配置指南配置 MCP 服务

使用

请参阅提示词模板指南，了解详细的使用说明和示例。

开发

开发工作流

1. 设置开发环境：

# Clone and set up the repository
git clone https://github.com/ibproduct/ib-api-doc.git
cd ib-api-doc
npm install

2. 配置开发 MCP 服务：

• 在 MCP 设置文件中创建开发配置
• 将其指向本地开发构建
• 将所有工具包含在 alwaysAllow 数组中

3. 开发周期：

# Make code changes
npm run build  # Build the changes
# Reload VSCode window to pick up new build
# Test using the development server configuration
# Repeat until satisfied with changes

4. 提交前：

• 测试所有受影响的功能
• 根据需要更新文档
• 遵循以下 Git 工作流

Git 工作流

1. 开始开发前：

git pull origin main
npm install  # If dependencies have changed

2. 开发期间：

• .gitignore 文件已配置为排除：
  • 构建产物（build/、dist/）
  • 依赖项（node_modules/）
  • 环境文件（.env*）
  • IDE 文件（.vscode/、.idea/）
  • 日志和调试文件
  • 系统文件（.DS_Store、Thumbs.db）

3. 提交更改：

git add .  # Stage changes (respects .gitignore)
git commit -m "type: description

- Bullet points for specific changes
- Another change"

4. 推送更改：

git pull origin main  # Get latest changes
git push origin main  # Push your changes

开发服务

如需在开发模式下运行 MCP 服务并启用自动重新加载：

npm run watch

如需检查 MCP 服务的功能：

npm run inspector

许可证

私有 - IntelligenceBank © 2024