Click-mcp 中文文档

概述

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