Bring MCP Server

Bring MCP サーバー

Bring Shopping Lists API と統合する Model Context Protocol（MCP）サーバーです。AI アシスタントが自然言語を通じて買い物リストを管理できるようにします。

免責事項： このプロジェクトでは、一般公開もサポートもされていない非公式の Bring API を使用しています。これらの API は予告なく変更され、機能に支障が生じる可能性があります。ご自身の責任でご利用ください。

概要

このプロジェクトは、Bring Shopping Lists API に接続する、機能を網羅した TypeScript 製の Model Context Protocol（MCP）サーバーを実装しています。Claude、ChatGPT などの AI アシスタントが、標準化されたプロトコルを通じて Bring の買い物リストを操作できるようにします。

機能

• MCP プロトコルのサポート：AI アシスタントとシームレスに統合できるよう、Model Context Protocol を実装
• Stdio トランスポート：Claude for Desktop などの MCP 対応クライアントと互換性があります
• Bring API 統合：Bring Shopping List API と完全に統合し、次の機能を利用できます：
  • すべての買い物リストを一覧表示
  • 買い物リストのアイテムを取得
  • レシピのアイテムを買い物リストに追加
  • 特定のアイテムを削除、または買い物リスト全体を消去
  • リストのアイテムに関する詳細情報を取得
  • 買い物リストへのアクセス権を持つユーザーをすべて表示

前提条件

• Bring アカウント（メールアドレスとパスワード）
• Bring API キー

インストール

1. リポジトリをクローンします：

   git clone <repository-url>
   cd bring-mcp-server
   

2. 依存関係をインストールします：

   npm install
   

3. プロジェクトのルートに、次の変数を含む .env ファイルを作成します：

   BRING_EMAIL=your_bring_account_email
   BRING_PASSWORD=your_bring_account_password
   BRING_API_KEY=your_bring_api_key
   

4. プロジェクトをビルドします：

   npm run build
   

使用方法

サーバーの起動

次のコマンドで MCP サーバーを起動します：

node dist/index.js

サーバーは stdio 経由で接続するため、Claude for Desktop などの MCP クライアントと互換性があります。

Claude for Desktop への接続

1. この MCP サーバーを使用するように Claude for Desktop を設定します
2. Claude との会話で、Bring の買い物リストを操作できるようになります

利用可能な MCP ツール

サーバーは次のツールを MCP クライアントに公開します：

ツール名	説明
get-bring-lists	認証済みユーザーのすべての買い物リストを一覧表示します
get-bring-list-items	指定した買い物リストのすべてのアイテムを取得します
add-recipe-items-to-bring-list	複数のアイテムを一度に買い物リストに追加します
remove-item-or-all-from-bring-list	特定のアイテムを削除するか、リスト全体を消去します
get-bring-list-items-details	リスト内のアイテムに関する詳細情報を取得します
get-all-users-from-bring-list	指定したリストへのアクセス権を持つユーザーをすべて一覧表示します

開発

開発モードでの実行

npm run dev

開発用に、ホットリロードを有効にしてサーバーを起動します。

VS Code との統合

VS Code との統合については、.vscode/mcp.sample.json ファイルを参照してください。この設定を使用すると、VS Code から MCP サーバーに直接接続できます。

テスト

次のコマンドでテストスイート全体を実行します：

npm test

継続的インテグレーション

このプロジェクトでは、継続的インテグレーションに GitHub Actions を使用しています。main ブランチへのプッシュ時とプルリクエスト時に、自動テストが実行されます。

ワークフローの設定は .github/workflows/test.yml で確認できます。

テスト構成

テストは test/ ディレクトリに整理されています：

• handlers/ - 各 MCP ツールハンドラーのテストが含まれています
• mocks/ - テストで使用するモック実装が含まれています

ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細については LICENSE ファイルを参照してください。

---

機能のリクエストやバグ報告については、プロジェクトのリポジトリで issue を作成してください。