Click MCP

🚀 Click-mcp 日本語ドキュメント

click-mcp は Python のライブラリです。Click アプリケーションを拡張し、Model Context Protocol (MCP) をサポートすることで、AI エージェントが CLI ツールとやり取りできるようにします。

🚀 クイックスタート

click-mcp は、Python の Click アプリケーションを拡張し、Model Context Protocol (MCP) をサポートすることで、AI エージェントが CLI ツールとやり取りできるようにするライブラリです。以下に基本的な使い方を紹介します。

✨ 主な機能

• シンプルな @click_mcp デコレータ構文
• Click コマンドを自動的に MCP ツールに変換
• ネストされたコマンドグループをサポート
• 標準入出力 (stdio) ベースの MCP サーバーをサポート

📦 インストール

pip install click-mcp

💻 使用例

基本的な使用法

import click
from click_mcp import click_mcp

@click_mcp(server_name="my-cli-app")
@click.group()
def cli():
    """示例 CLI 应用程序。"""
    pass

@cli.command()
@click.option('--name', required=True, help='要问候的名字')
def greet(name):
    """问候某人。"""
    click.echo(f"你好，{name}!")

if __name__ == '__main__':
    cli()

MCP サーバーを起動すると、Click コマンドが MCP ツールに変換されます。

python3 your_script.py serve

出力は以下のようになります。

MCP Server starting on port 8080...

高度な使用法

カスタムコマンド名とサーバー名

server_name と command_name パラメータを使用して、MCP サーバーの名前とコマンドの名前をカスタマイズできます。

@click_mcp(server_name="my-custom-server", command_name="my-command")
def my_command():
    pass

ネストされたコマンドグループ

click-mcp はネストされたコマンドグループをサポートしており、異なる機能のサブコマンドを作成できます。

📚 ドキュメント

エラー処理

実行時にエラーが発生した場合、click-mcp は自動的に例外をキャッチし、JSON 形式で返します。

{
    "error": {
        "type": "ValueError",
        "message": "invalid value"
    }
}

開発

環境のセットアップ

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

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

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

   pip install hatch
   

テストの実行

# すべてのテストを実行
hatch run test

# カバレッジ付きでテスト
hatch run cov

コードのフォーマット

# コードをフォーマット
hatch run format

# フォーマットをチェック
hatch run check-format

コードのチェック

hatch run lint

型チェック

hatch run typecheck

すべてのチェックを実行

hatch run check-all

ビルド

hatch run build

ドキュメントの生成

hatch run docs

関連リソース

• Model Context Protocol (MCP) 仕様
• Click ドキュメント
• MCP ツールレジストリ

📄 ライセンス

MIT