README
🚀 数独问题 MCP 服务器项目
这是一个 MCP 服务器项目,专注于解决数独问题。它实现了笔记存储系统、提示生成和笔记添加等功能,为用户提供便捷的数独问题处理体验。
🚀 快速开始
安装
在 Claude Desktop 上
- MacOS 系统:配置文件路径为
~/Library/Application\ 支持/Claude/claude_desktop_config.json - Windows 系统:配置文件路径为
%APPDATA%/Claude/claude_desktop_config.json
开发/未发布的服务器配置
``` "mcpServers": { "sodukusolver": { "command": "uv", "args": [ "--directory", "/Users/harrisonliang/research/fun/soduku", "run", "sodukusolver" ] } } ```已发布的服务器配置
``` "mcpServers": { "sodukusolver": { "command": "uvx", "args": [ "sodukusolver" ] } } ```✨ 主要特性
资源
该服务器实现了一个简单的笔记存储系统,具备以下功能:
- 自定义
note://URI 方案,可用于访问单个笔记。 - 每个笔记资源包含名称、描述和
text/plain格式的内容类型。
提示
该服务器提供一个提示功能:
summarize-notes:能够生成所有存储笔记的摘要。- 支持可选的 "style" 参数来控制详细程度(简洁/详细)。
- 可根据风格偏好生成包含所有当前笔记内容的提示。
工具
该服务器实现了一个工具:
add-note:用于向服务器添加新的笔记。- 接受 "name" 和 "content" 作为必填字符串参数。
- 会更新服务器状态并通知客户端资源变化。
📦 安装指南
在 Claude Desktop 上
MacOS 系统
配置文件路径为 ~/Library/Application\ 支持/Claude/claude_desktop_config.json。
Windows 系统
配置文件路径为 %APPDATA%/Claude/claude_desktop_config.json。
开发/未发布的服务器配置
``` "mcpServers": { "sodukusolver": { "command": "uv", "args": [ "--directory", "/Users/harrisonliang/research/fun/soduku", "run", "sodukusolver" ] } } ```已发布的服务器配置
``` "mcpServers": { "sodukusolver": { "command": "uvx", "args": [ "sodukusolver" ] } } ```💻 使用示例
基础用法
在开发和发布流程中,使用以下命令进行操作:
同步依赖项并更新锁定文件
uv sync
构建包分发
uv build
这将在 dist/ 目录中创建源代码和轮格式的发行版。
发布到 PyPI
uv publish
注意:您需要通过环境变量或命令行标志设置 PyPI 凭证:
- 令牌:
--token或UV_PUBLISH_TOKEN - 或用户名/密码:
--username/UV_PUBLISH_USERNAME和--password/UV_PUBLISH_PASSWORD
高级用法
调试
由于 MCP 服务器通过标准输入输出运行,调试可能具有挑战性。为了获得最佳的调试体验,我们强烈推荐使用 MCP Inspector。
您可以通过 npm 执行以下命令启动 MCP 检查器:
npx @modelcontextprotocol/inspector uv --directory /Users/harrisonliang/research/fun/soduku run sodukusolver
启动后,检查器将在浏览器中显示一个 URL,您可以在该浏览器访问以开始调试。
📚 详细文档
配置
[TODO:添加特定于您实现的配置详细信息]
开发
构建和发布
为了准备分发包,需要按以下步骤操作:
- 同步依赖项并更新锁定文件:
uv sync
- 构建包分发:
uv build
这将在 dist/ 目录中创建源代码和轮格式的发行版。
3. 发布到 PyPI:
uv publish
注意:您需要通过环境变量或命令行标志设置 PyPI 凭证:
- 令牌:
--token或UV_PUBLISH_TOKEN - 或用户名/密码:
--username/UV_PUBLISH_USERNAME和--password/UV_PUBLISH_PASSWORD
调试
由于 MCP 服务器通过标准输入输出运行,调试可能具有挑战性。为了获得最佳的调试体验,我们强烈推荐使用 MCP Inspector。
您可以通过 npm 执行以下命令启动 MCP 检查器:
npx @modelcontextprotocol/inspector uv --directory /Users/harrisonliang/research/fun/soduku run sodukusolver
启动后,检查器将在浏览器中显示一个 URL,您可以在该浏览器访问以开始调试。
Scan to contact