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