Bruno Api MCP

🚀 Bruno API MCP 服务器

Bruno API MCP 服务器将 Bruno API 集合作为 MCP 工具暴露出来，借助 Model Context Protocol（MCP）协议，让您能与 Bruno API 集合交互，使 API 集合可被 AI 代理和其他 MCP 客户端使用。

🚀 快速开始

Bruno API MCP 服务器旨在解决开发人员集成第三方 API 时面临的难题，实现代码与数据的分离，方便团队共享 API 请求、进行版本控制并确保配置和依赖的一致性。

✨ 主要特性

• 自动转换：把 Bruno 集合里的每个请求自动转换成 MCP 工具。
• 环境管理：支持开发、测试、生产等不同运行时环境，便于切换变量和配置。
• 变量替换：可在 URL、标头和请求正文中替换变量，定制请求。
• 查询参数：允许添加或覆盖查询参数，增加请求灵活性。
• 自定义主体参数：能直接在请求正文中指定自定义参数。

📦 安装指南

安装与运行

1. 安装 Bruno CLI：

   npm install -g bruno
   

2. 初始化项目：

   bruno init
   

3. 添加请求： 将 API 请求保存到 requests/ 文件夹中的 .bruno 文件里。
4. 生成工具：

   bruno generate
   

5. 调用工具： 利用 MCP 协议直接调用生成的工具。

💻 使用示例

基础用法

假设有一个请求文件 requests/get-user.bruno，内容如下：

{
  "url": "{{baseUrl}}/users/{{userId}}",
  "headers": {
    "Authorization": "Bearer {{apiKey}}"
  },
  "query": {
    "include": "posts"
  }
}

调用时，可通过 MCP 协议传递自定义变量：

{
  "environment": "dev",
  "variables": {
    "userId": "123",
    "apiKey": "your-api-key"
  }
}

高级用法

结合所有自定义选项的完整示例：

{
  "environment": "staging",
  "variables": {
    "dealId": "abc123",
    "apiKey": "test-key-staging"
  },
  "query": {
    "limit": 5,
    "sort": "created_at"
  },
  "body": {
    "status": "active",
    "amount": 100.5
  }
}

📚 详细文档

预定义脚本

• 启动服务器：

  npm start
  

• 构建项目：

  npm run build
  

开发

贡献指南

1. 克隆仓库：

   git clone https://github.com/your-repo.git
   cd your-repo
   

2. 安装依赖项：

   npm install
   

3. 运行测试：

   npm test
   

工具列表

• 环境工具：bruno env
• 生成工具：bruno generate
• 调用工具：bruno call

使用自定义参数与工具

当调用由 Bruno API 集合生成的 MCP 工具时，可提供以下自定义配置：

环境覆盖

指定不同的环境以使用特定的变量设置：

{
  "environment": "prod"
}

变量替换

在 URL、标头和请求正文中替换变量：

{
  "variables": {
    "userId": "123",
    "apiKey": "test-key"
  }
}

查询参数

添加或覆盖查询参数：

{
  "query": {
    "page": 1,
    "per_page": 10
  }
}

自定义主体参数

在请求正文中指定自定义参数：

{
  "body": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}

📄 许可证

MIT License