使用说明
项目简介
本项目是一个实现了 Model Context Protocol (MCP) 协议的服务器,旨在为大型语言模型 (LLM) 客户端提供字符计数功能。它通过 MCP 协议定义了一个名为 'count_words' 的工具,允许客户端请求服务器计算指定日文文本的字符数量。
主要功能点
- 提供字符计数工具: 通过 'count_words' 工具,客户端可以发送日文文本到服务器,获取去除空格和换行符后的字符数。
- MCP 服务器: 遵循 MCP 协议,可以与任何兼容 MCP 协议的 LLM 客户端进行通信。
- 易于安装和运行: 使用 'uv' 进行依赖管理和运行,安装步骤简单明了。
安装步骤
-
安装依赖: 确保你的系统已安装 'uv' 包管理器。然后,在仓库根目录下执行以下命令安装项目依赖:
uv sync --dev --all-extras这个命令会安装项目所需的开发和所有额外依赖。
-
安装 MCP 服务器: 执行以下命令安装并启动 MCP 服务器:
uv run mcp install server.py这个命令会使用 'mcp install' 命令来安装并运行 'server.py' 文件,启动 Word Counter MCP 服务器。
服务器配置
MCP 客户端需要配置以下信息才能连接到 Word Counter MCP 服务器。将以下 JSON 配置添加到你的 MCP 客户端配置中:
{ "serverName": "WordCounter", // MCP 服务器的名称,与 server.py 中 FastMCP 实例化的名称一致 "command": "uv", // 启动服务器的命令,这里使用 uv "args": [ // 启动命令的参数 "run", // uv run 子命令,用于运行脚本 "mcp", // 运行 mcp 命令 "install", // mcp install 子命令,用于安装和启动服务器 "server.py" // 服务器脚本文件路径 ] }
配置说明:
- 'serverName': 服务器名称,必须与 'server.py' 中 'FastMCP("WordCounter")' 定义的名称一致。客户端通过此名称识别服务器。
- 'command': 启动服务器进程的命令。这里使用 'uv' 包管理器。
- 'args': 传递给 'command' 的参数列表。
- '"run"': 'uv run' 命令用于执行指定的脚本或命令。
- '"mcp"': 指明要运行 'mcp' 相关的功能。
- '"install"': 使用 'mcp install' 子命令来安装和启动服务器脚本。
- '"server.py"': 指定要执行的服务器脚本文件是 'server.py'。
基本使用方法
- 启动服务器: 按照安装步骤启动 Word Counter MCP 服务器。
- 配置 MCP 客户端: 在你的 MCP 客户端中,配置上述服务器配置信息,确保客户端能够连接到服务器。
- 调用 'count_words' 工具: 使用 MCP 客户端向 Word Counter MCP 服务器发送请求,调用 'count_words' 工具,并提供需要计算字符数的日文文本作为参数。服务器将返回文本的字符数。
例如,一个 MCP 客户端请求可能如下 (JSON-RPC 格式,仅为示例,实际客户端操作请参考对应客户端文档):
{ "jsonrpc": "2.0", "method": "call_tool", "params": { "tool_name": "count_words", "arguments": { "text": "こんにちは世界" } }, "id": 1 }
服务器会返回响应,包含字符数:
{ "jsonrpc": "2.0", "result": 7, "id": 1 }
信息
分类
开发者工具