Bruno Api MCP

🚀 Bruno API MCP サーバー

Bruno API コレクションを MCP ツールとして公開する Model Context Protocol（MCP）サーバーです。このサーバーを使用すると、MCP プロトコルを介して Bruno API コレクションとやり取りでき、API コレクションを AI エージェントや他の MCP クライアントが利用できるようになります。

🚀 クイックスタート

Bruno API MCP サーバーは、開発者が API を効率的に管理し、AI エージェントや他の MCP クライアントとの連携を容易にするためのソリューションです。このサーバーを使用することで、API リクエストをファイルに保存し、再利用可能なツールとして提供することができます。

✨ 主な機能

• 自動変換：Bruno コレクション内の各リクエストを自動的に MCP ツールに変換します。
• 環境管理：開発、テスト、本番などの異なるランタイム環境をサポートし、変数と設定の切り替えを容易にします。
• 変数置換：URL、ヘッダー、リクエスト本文でスカラー変数を使用し、リクエストをカスタマイズできます。
• クエリパラメータ：クエリパラメータの追加や上書きを許可し、より柔軟なリクエストを可能にします。
• カスタム本文パラメータ：リクエスト本文で直接カスタムパラメータを指定できます。

📦 インストール

インストールと実行

1. Bruno CLI のインストール：

   npm install -g bruno
   

2. プロジェクトの初期化：

   bruno init
   

3. リクエストの追加： API リクエストを requests/ フォルダ内の .bruno ファイルに保存します。
4. ツールの生成：

   bruno generate
   

5. ツールの呼び出し： MCP プロトコルを使用して生成されたツールを直接呼び出します。

💻 使用例

基本的な使用法

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

高度な使用法

呼び出し時には、MCP プロトコルを使用してカスタム変数を渡すことができます。

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

📚 ドキュメント

なぜ重要なのか：ソースコードとデータの連携

開発者がサードパーティ API を統合する際、通常は3つの主要な課題に直面します。

1. システム境界を越えたデバッグ：異なるコードとデータ環境で問題を診断することは困難です。
2. API リクエストの重複定義：各呼び出しで同じ URL、ヘッダー、その他の設定を手動でコピーアンドペーストする必要があり、非効率的です。
3. バージョン管理と依存関係管理：API の変更や要件の調整に伴い、これらの変更を効果的に追跡および管理することが困難です。

Bruno はこれらの問題を解決します。API リクエストをファイルに保存し、各リクエストに対して再利用可能なツールを生成することで、コードとデータを分離します。これにより、チーム内で API リクエストを簡単に共有し、バージョン管理を行い、すべての人が同じ設定と依存関係を使用することを保証できます。

予め定義されたスクリプト

• サーバーの起動：

  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"
  }
}

完全な例

すべてのカスタムオプションを組み合わせた完全な例です。

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

📄 ライセンス

MIT License