MCP Server Miro

🚀 Miro MCP サーバー

このサーバーは、Miro API とシングルボードとのインタラクションを目的とした、実験的なモデル制御プロトコル (MCP) サーバーです。

🚀 クイックスタート

このプロジェクトでは、FastMCP サーバーを提供しています。このサーバーは Miro API エンドポイントを AI エージェントが利用できるツールとして公開し、Miro OpenAPI 仕様から自動的にツール定義を生成することで、AI エージェントが Miro ボードをプログラムで操作できるようにします。

✨ 主な機能

• 主要な Miro ボード項目タイプをすべてサポートします：
  • メモ
  • 形状
  • テキスト
  • 画像
  • カード
  • アプリカード
  • ドキュメント
  • 埋め込み
  • コネクター

📦 インストール

前提条件

• Node.js
• API アクセス権を持つ Miro アカウント
• Miro API トークン
• Miro ボード ID

Docker を使用しない場合

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

   git clone https://github.com/yourusername/mcp-server-miro.git
   cd mcp-server-miro
   

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

   npm install
   

3. ルートディレクトリに .env ファイルを作成し、以下の変数を含めます：

   MIRO_API_TOKEN=あなたの_miro_api_token
   MIRO_BOARD_ID=あなたの_miro_board_id
   
   # オプション、ポート
   PORT=3000
   

使用方法

1. サーバーを起動します：

   npm run dev
   

   または

   npm run build
   npm start
   

2. サーバーは http://localhost:8899/sse で実行されます。

3. AI エージェントは、MCP プロトコルを介して公開された Miro API ツールを使用できます。

Docker を使用する場合

# 具体的なコマンドは Docker のバージョンによります
docker compose up -d
docker-compose up -d

# サーバーはデフォルトポートまたは選択したポートで実行されるはずです

📚 ドキュメント

API ツール

このサーバーは、以下の Miro API エンドポイントをツールとして公開しています：

ボード操作：

• get_specific_board：現在のボードの情報を取得します。
• update_board：現在のボードを更新します。

汎用項目操作：

• get_items：ボード上の項目リストを取得します（フィルタリングとページングをサポート）。
• update_item_position_or_parent：特定の項目の現在の位置または親を更新します。
• delete_item：特定の項目を削除します（メモ、テキスト、形状などのさまざまなタイプを含む）。

メモ操作：

• create_sticky_note_item：メモを追加します。
• get_sticky_note_item：特定のメモを取得します。
• update_sticky_note_item：特定のメモを更新します。

テキスト操作：

• create_text_item：テキストを追加します。
• get_text_item：特定のテキストを取得します。
• update_text_item：特定のテキストを更新します。

形状操作：

• create_shape_item：形状項目を追加します。
• get_shape_item：特定の形状を取得します。
• update_shape_item：特定の形状を更新します。

カード操作：

• create_card_item：カードを作成します。
• get_card_item：特定のカードを取得します。
• update_card_item：特定のカードを更新します。

コネクター操作：

• get_connection：接続情報を取得します。
• add_connection：接続を追加します。
• remove_connection：接続を削除します。

ドキュメント操作：

• get_document：ドキュメントの内容を取得します。
• update_document：ドキュメントの内容を更新します。

埋め込み操作：

• get_embed：埋め込み内容を取得します。
• update_embed：埋め込み内容を更新します。

🔧 注意事項

⚠️ 重要提示

API トークンが必要な操作を実行するための適切な権限を持っていることを確認してください。

💡 使用建议

ポート変数 PORT はオプションで、デフォルト値は 3000 です。サーバーを起動した後は、http://localhost:8899/sse にアクセスすることでインタラクションできます。