使用说明
项目简介
'mcp-dice' 是一个实现了 Model Context Protocol (MCP) 的服务器,专门为大型语言模型 (LLM) 提供掷骰子功能。通过这个服务器,LLM 可以利用标准的骰子表示法(例如 '1d20', '2d6+3')进行掷骰子,并获得骰子的点数和总和,从而扩展 LLM 在游戏、故事创作等方面的能力。
主要功能点
- 支持标准骰子表示法: 能够解析和执行如 '1d20', '3d6', '2d8+1' 等常见的骰子表示法。
- 返回详细掷骰结果: 不仅返回骰子的总和,还提供每次掷骰的点数,方便 LLM 进行更细致的分析和应用。
- 易于集成 Claude Desktop: 提供了与 Claude Desktop 集成的配置示例,方便用户快速上手。
- 兼容 MCP Inspector: 支持 MCP Inspector 工具,方便开发者调试和测试服务器。
安装步骤
- 安装 'uv': 'mcp-dice' 依赖 'uv' 包管理器。请根据 uv 官方文档 安装 'uv'。
服务器配置
要将 'mcp-dice' 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令和参数。以下是配置示例,您可以根据您的操作系统选择合适的配置添加到 MCP 客户端的配置文件中。
Claude Desktop 配置文件位置:
- macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
配置示例 (JSON 格式):
{ "mcpServers": { "dice": { // 服务器名称,可以自定义,例如 "dice" "command": "uvx", // 启动服务器的命令,这里使用 uvx (uv 的执行器) "args": ["mcp-dice"] // 传递给命令的参数,这里指定运行 mcp-dice 服务器 } } }
参数注释:
- '"dice"': 服务器在 MCP 客户端中显示的名称,您可以自定义,例如 "dice_server" 或 "roll_dice_service"。
- '"command": "uvx"': 指定用于启动 'mcp-dice' 服务器的可执行命令。 'uvx' 是 'uv' 包管理器提供的执行器,用于运行 Python 应用。请确保您的环境中 'uvx' 命令可用。
- '"args": ["mcp-dice"]': 传递给 'uvx' 命令的参数,'"mcp-dice"' 是 'mcp-dice' 包的入口点,它会启动 MCP 服务器。
更多配置示例 (针对不同环境):
<details> <summary>macOS 配置</summary></details> <details> <summary>WSL 配置</summary>{ "mcpServers": { "dice": { "command": "uvx", "args": ["mcp-dice"] } } }
{ "mcpServers": { "dice": { "command": "wsl", "args": [ "-e", "zsh", // 您的登录 shell,例如 bash, zsh "-lc", "uvx mcp-dice" ] } } }
WSL 配置参数注释:
- '"command": "wsl"': 在 Windows Subsystem for Linux (WSL) 环境中运行命令。
- '"args": [...]': 传递给 'wsl' 的参数列表。
- '"-e", "zsh"': 指定在 WSL 中使用的 shell,请替换为您的实际 shell (例如 "bash", "zsh")。
- '"-lc"': '-l' 表示以 login shell 方式启动,'-c' 表示执行后面的命令字符串。
- '"uvx mcp-dice"': 在 WSL shell 中执行的命令,与 macOS 配置相同,使用 'uvx' 启动 'mcp-dice' 服务器。
基本使用方法
- 配置 MCP 客户端: 根据上述服务器配置部分,将配置信息添加到您的 MCP 客户端配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json')。
- 启动 MCP 服务器: MCP 客户端通常会自动启动配置的 MCP 服务器。如果需要手动启动,您可以在命令行中使用 'uvx mcp-dice' 命令启动服务器。
- 在 MCP 客户端中使用: 在支持 MCP 的 LLM 客户端中(例如配置了 'mcp-dice' 的 Claude Desktop),您可以指示 LLM 使用 'roll_dice' 工具或读取 'dice://' 资源来执行掷骰子操作。例如,您可以向 LLM 提问: "请帮我掷一个 2d6 的骰子" 或 "roll 1d20 for me"。LLM 客户端会根据您的指令调用 'mcp-dice' 服务器,并返回掷骰结果。
开发和调试
仓库的 'README.md' 文件提供了详细的开发和调试指南,包括如何安装开发依赖、运行测试以及使用 MCP Inspector 进行调试。您可以参考 'README.md' 文件了解更多信息。
信息
分类
AI与计算