使用说明

项目简介

Sudoku Solver MCP Server 是一个实现了 Model Context Protocol (MCP) 的应用后端,旨在为大型语言模型 (LLM) 客户端提供上下文信息和功能。它主要用于管理笔记和数独谜题资源,并提供相应的工具供 LLM 调用,例如添加笔记、添加数独谜题、求解数独谜题以及总结笔记。

主要功能点

  • 资源管理:
    • 笔记 (Notes): 支持创建、存储和访问文本笔记。每个笔记都有名称、描述和内容,可以通过 'note://' URI scheme 访问。
    • 数独谜题 (Sudoku Puzzles): 支持创建、存储和访问数独谜题。每个谜题都有名称和文本格式的谜题数据,可以通过 'sudoku://' URI scheme 访问。
  • 工具 (Tools):
    • 'add-note': 添加新的笔记到服务器。
    • 'add-sudoku': 添加新的数独谜题到服务器。
    • 'solve-sudoku': 求解已存储的数独谜题。
    • 'solve-sudoku-text': 求解通过文本输入的数独谜题。
  • Prompt 模板 (Prompts):
    • 'summarize-notes': 生成所有已存储笔记的摘要,可以控制摘要的详细程度。

安装步骤

  1. 环境准备: 确保已安装 Python 环境。推荐使用 'uv' 包管理器,可以参考仓库 README.md 中的 "Development" -> "Building and Publishing" 部分进行安装和配置。
  2. 安装依赖: 使用 'uv sync' 命令同步项目依赖并更新 lockfile。
  3. 构建: 使用 'uv build' 命令构建项目分发包,这将在 'dist/' 目录下生成 wheel 文件。

服务器配置

要将 Sudoku Solver MCP Server 配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令和参数。以下是配置信息,请根据您的实际情况选择合适的配置并添加到 MCP 客户端的配置文件中。

开发/未发布服务器配置 (Development/Unpublished Servers Configuration)

适用于开发环境,服务器程序直接从项目目录运行。

{
  "server name": "sodukusolver",
  "command": "uv",
  "args": [
    "--directory",
    "/path/to/mcp-soduku",  //  请替换为您的 mcp-soduku 仓库的绝对路径
    "run",
    "sodukusolver"
  ]
}

参数说明:

  • 'server name': 服务器名称,客户端用此名称来标识和调用该服务器,例如 "sodukusolver"。
  • 'command': 启动服务器的命令,这里使用 'uv' 包管理器。
  • 'args': 传递给 'uv' 命令的参数列表:
    • '--directory': 指定服务器程序所在的目录,请务必将其替换为您本地 mcp-soduku 仓库的绝对路径
    • 'run': 'uv run' 命令用于运行 Python 模块。
    • 'sodukusolver': 指定要运行的 Python 模块名称,对应于项目中的 'src/sodukusolver/init.py' 和 'src/sodukusolver/server.py'。

发布服务器配置 (Published Servers Configuration)

适用于发布环境,服务器程序已经打包并可以通过 'uvx' 命令直接运行。

{
  "server name": "sodukusolver",
  "command": "uvx",
  "args": [
    "sodukusolver"
  ]
}

参数说明:

  • 'server name': 服务器名称,同上。
  • 'command': 启动服务器的命令,这里使用 'uvx',用于运行已打包的 Python 应用。
  • 'args': 传递给 'uvx' 命令的参数列表:
    • 'sodukusolver': 指定要运行的应用名称,这通常是打包时定义的应用入口。

选择配置: 如果您正在开发或测试阶段,建议使用 开发/未发布服务器配置,并确保将 '/path/to/mcp-soduku' 替换为实际路径。如果您已经构建并发布了服务器包,可以使用 发布服务器配置

配置位置: MCP 客户端的配置文件位置通常为:

  • MacOS (Claude Desktop): '~/Library/Application\ Support/Claude/claude_desktop_config.json'
  • Windows (Claude Desktop): '%APPDATA%/Claude/claude_desktop_config.json'

请根据您的 MCP 客户端的文档,将上述 JSON 配置信息添加到相应的配置文件中的 'mcpServers' 字段下。

基本使用方法

  1. 启动 MCP 客户端: 启动配置了 Sudoku Solver MCP Server 的 MCP 客户端(例如 Claude Desktop)。
  2. 客户端连接服务器: 客户端会自动尝试连接到配置的 MCP 服务器。
  3. 使用工具和 Prompt: 在 MCP 客户端中,您应该能够看到 Sudoku Solver MCP Server 提供的工具和 Prompt。您可以指示 LLM 使用这些工具来:
    • 添加笔记 (使用 'add-note' 工具)
    • 添加数独谜题 (使用 'add-sudoku' 工具)
    • 求解数独谜题 (使用 'solve-sudoku' 或 'solve-sudoku-text' 工具)
    • 总结笔记 (使用 'summarize-notes' Prompt)

具体如何通过自然语言指示 LLM 调用这些工具和 Prompt,请参考您的 MCP 客户端的使用说明。例如,您可以对 Claude 说 "请帮我添加一个名为 '工作想法' 的笔记,内容是 '今天想到了一个很棒的工作方案...'",Claude 可能会识别出 'add-note' 工具并调用它。

注意: Sudoku Solver MCP Server 通过标准输入/输出 (stdio) 与 MCP 客户端通信。确保您的 MCP 客户端支持 stdio 类型的 MCP 服务器连接。

信息

分类

AI与计算