Click MCP

🚀 Click-mcp 中文文檔

click-mcp 是一個 Python 庫，它對 Click 應用程序進行擴展，使其支持 Model Context Protocol (MCP)，從而允許 AI 代理與 CLI 工具進行交互。

🚀 快速開始

click-mcp 是一個強大的 Python 庫，能讓 Click 應用程序支持 MCP，實現 AI 代理與 CLI 工具的交互。

✨ 主要特性

• 簡單的 @click_mcp 裝飾器語法。
• 自動將 Click 命令轉換為 MCP 工具。
• 支持嵌套命令組。
• 基於標準輸入輸出 (stdio) 的 MCP 服務器支持。

📦 安裝指南

使用以下命令安裝 click-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 許可證。