使用说明
项目简介
Chess.com MCP服务器是一个实现了Model Context Protocol (MCP) 的应用后端,旨在为AI助手提供便捷访问 Chess.com 公开数据API 的能力。通过此服务器,AI助手可以获取棋手资料、比赛数据、俱乐部信息等,从而实现更丰富的国际象棋相关应用,例如棋局分析、选手信息查询等。
主要功能点
- 访问棋手信息:获取Chess.com 棋手的个人资料、统计数据和在线状态。
- 检索比赛记录:查询棋手在特定日期或月份的比赛记录。
- 俱乐部和头衔棋手信息:获取Chess.com 俱乐部和拥有头衔的棋手信息。
- 无需认证:使用 Chess.com 的公开 API,无需额外的身份验证。
- Docker 容器化支持:易于部署和运行,推荐使用 Docker 部署。
- 提供交互式工具:为 AI 助手提供可调用的工具,方便集成到各种 LLM 应用中。
安装步骤
- Docker (推荐):如果您的环境已安装 Docker,这是最简便的运行方式。无需额外安装步骤,只需配置 MCP 客户端即可。
- UV (备选):
- 确保您的系统已安装 uv。您可以参考 uv 官方文档进行安装。
- 克隆仓库到本地: 'git clone https://github.com/pab1it0/chess-mcp.git'
- 进入仓库目录: 'cd chess-mcp'
- 创建虚拟环境并安装依赖:
uv venv source .venv/bin/activate # On Unix/macOS .venv\Scripts\activate # On Windows uv pip install -e .
服务器配置
MCP 客户端配置 (JSON 格式):
您需要在您的 MCP 客户端(例如 Claude Desktop)的配置文件中添加以下服务器配置信息。
1. Docker 部署配置 (推荐)
{ "mcpServers": { "chess": { "command": "docker", // 运行命令,这里使用 docker "args": [ // 命令参数 "run", "--rm", // 容器退出后自动删除 "-i", // 保持STDIN打开,即使没有连接 "pab1it0/chess-mcp" // Docker 镜像名称 ] } } }
2. UV 部署配置
{ "mcpServers": { "chess": { "command": "uv", // 运行命令,这里使用 uv "args": [ // 命令参数 "--directory", // 指定工作目录 "<full path to chess-mcp directory>", // 请替换为 chess-mcp 仓库在您本地的完整路径,例如 "/Users/yourname/chess-mcp" "run", // uv run 命令 "src/chess_mcp/main.py" // 服务器启动脚本路径 ] } } }
注意: 使用 UV 部署时,请将 '<full path to chess-mcp directory>' 替换为您本地 chess-mcp 仓库的实际完整路径。 如果 Claude Desktop 提示 'Error: spawn uv ENOENT',您可能需要提供 'uv' 命令的完整路径,或者在配置中设置环境变量 'NO_UV=1'。
基本使用方法
- 根据您的选择(Docker 或 UV)启动 Chess.com MCP 服务器。
- 在您的 MCP 客户端中配置上述相应的服务器配置信息。
- 客户端成功连接到服务器后,即可通过 MCP 协议调用服务器提供的工具 (Tools) 和资源 (Resources),例如查询棋手资料、比赛记录等。
- 具体的工具和资源列表,请参考仓库 'README.md' 文档中的 "Available Tools" 部分。
信息
分类
网页与API