Yokan Board MCP

🚀 Yokan Board MCP

このプロジェクトは、YokanカンバンボードAPI用のモデルコンテキストプロトコル（MCP）サーバーです。AIエージェントがカンバンボード、カラム、タスクを管理してやり取りできるツールベースのインターフェースを提供します。

✨ 主な機能

• ボード管理：カンバンボードの作成、取得、更新、削除ができます。
• カラム管理：ボード内のカラムの作成、取得、更新、並べ替え、削除ができます。
• タスク管理：タスクの作成、取得、更新、移動、削除ができます。
• エージェント対応：マスターコントロールプロトコルを介してAIエージェントが使用できるように設計されています。

📦 インストール

Dockerイメージのビルドと実行

新しいユーザーや開発環境をセットアップせずにサーバーを実行したいユーザーには、Dockerの使用をおすすめします。

1. Dockerイメージをビルドする：

   docker build -t yokanboard/yokan-mcp .
   

2. Dockerコンテナを実行する：

   docker run -p 8888:8888 --name yokan-mcp -e YOKAN_API_BASE_URL=http://your-yokan-api-host:port/api yokanboard/yokan-mcp
   

   http://your-yokan-api-host:port/api を実際のYokan APIインスタンスのURLに置き換えてください。

MCPクライアントの設定

ストリーム可能なトランスポートを使用したGemini CLI

以下の内容で .gemini/settings.json を作成します。

{
    "mcpServers": {
        "yokan-board": {
            "httpUrl": "http://[your-yokan-mcp-host]:8888/mcp",
            "headers": {
                "Authorization": "Bearer [TOKEN]",
                "accept": "application/json"
            }
        }
    }
}

Stdioトランスポートを使用したVS Code Copilot

以下の内容で .vscode/mcp.json ファイルを作成します。

{
    "servers": {
        "yokan-board": {
            "type": "stdio",
            "command": "uv",
            "args": [
                "run",
                "--directory",
                "/full/path/to/yokan-board-mcp-project-folder/yokan-board-mcp",
                "-m",
                "src.main",
                "--stdio"
            ]
        }
    }
}

開発環境のセットアップ

前提条件

• Python 3.8以上
• uv（Python環境の管理用）
• Yokan API の実行インスタンスへのアクセス

セットアップ手順

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

   git clone https://github.com/yokan-board/yokan-board-mcp.git
   cd yokan-board-mcp
   

2. 仮想環境を作成してアクティブ化する：

   uv venv
   source .venv/bin/activate
   

3. 依存関係をインストールする：

   uv sync
   

設定

1. .env.example をコピーして .env ファイルを作成する：

   cp .env.example .env
   

2. .env ファイルを編集して、Yokan APIインスタンスを指すようにする：

   YOKAN_API_BASE_URL=http://your-yokan-api-host:port/api
   

サーバーの実行

開発用にMCPサーバーを起動するには、以下のコマンドを実行します。

uvicorn src.main:app --host localhost --port 8888 --reload

テスト

統合テストを実行するには、実行中のYokan APIインスタンスとテストユーザーが必要です。テストはユーザー名 user とパスワード password を使用するように設定されています。

.env ファイルが YOKAN_API_BASE_URL で正しく構成されていることを確認してください。

以下のコマンドを使用してテストを実行します。

make test

📚 ドキュメント

利用可能なツール

MCPサーバーは、Yokanカンバンボードを管理するための以下のツールを公開しています。

💻 使用例

fastmcp クライアントライブラリを使用してMCPサーバーとやり取りすることができます。

認証

ツールを使用するには、まずYokan APIインスタンスからJWTトークンを取得する必要があります。これは、Yokan APIの /login エンドポイントに POST リクエストを送信することで行うことができます。

curl を使用した例：

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"username": "your_username", "password": "your_password"}' \
  http://localhost:3001/api/v1.1/login

MCPサーバーとのやり取りの例

fastmcp クライアントを使用してYokan MCPサーバーとやり取りする方法を示すPythonの例は、 で見つけることができます。

📄 ライセンス

Yokan Board MCPは、二重ライセンスで利用可能です。

• AGPLv3：GNU Affero General Public License Version 3の条件の下で、無料で使用、変更、配布できます（LICENSE.AGPLv3 を参照）。
• 商用ライセンス：AGPLv3のコピーレフト要件なしでYokanを使用したい組織に利用可能です（LICENSE.COMMERCIAL を参照）。

商用利用ライセンスに関する情報は、 yokan.board@gmail.com までメールでお問い合わせください。

著作権

Yokan Board MCPは Julian I. Kamil によって作成されました。 © Copyright 2025 Julian I. Kamil. All rights reserved.