README
🚀 ClickUp 操作器 MCP 服务器
ClickUp 操作器 MCP 服务器借助 Claude 完成部署,可实现简单的笔记存储系统,具备自定义 URI 方案、笔记摘要生成及添加笔记等功能。
🚀 快速开始
安装
Claude Desktop
在 MacOS 上:~/Library/Application\ Support/Claude/claude_desktop_config.json
在 Windows 上:%APPDATA%/Claude/claude_desktop_config.json%
开发/未发布的服务器配置
``` "mcpServers": { "clickup-operator": { "command": "uv", "args": [ "--directory", "C:\Users\noahv\Documents\GitHub\create-python-server\clickup-operator", "run", "clickup-operator" ] } } ```已发布的服务器配置
``` "mcpServers": { "clickup-operator": { "command": "uvx", "args": [ "clickup-operator" ] } } ```启动服务器
uv --directory C:\Users\noahv\Documents\GitHub\clickup-operator run clickup-operator
✨ 主要特性
资源
该服务器实现了一个简单的笔记存储系统,具备以下特点:
- 自定义 note:// URI 方案,用于访问单个笔记。
- 每个笔记资源包含名称、描述和 text/plain MIME 类型。
提示
该服务器提供一个提示功能:
- summarize-notes:创建所有存储笔记的摘要。
- 可选 "style" 参数来控制详细程度(简洁/详细)。
- 根据风格偏好生成结合所有当前笔记的提示。
工具
该服务器实现了一个工具:
- add-note:向服务器添加新的笔记。
- 接受 "name" 和 "content" 作为必需的字符串参数。
- 更新服务器状态并通知客户端资源更改。
📦 安装指南
Claude Desktop 配置文件路径
- MacOS:
~/Library/Application\ Support/Claude/claude_desktop_config.json - Windows:%APPDATA%/Claude/claude_desktop_config.json%
服务器配置
开发/未发布的服务器配置
``` "mcpServers": { "clickup-operator": { "command": "uv", "args": [ "--directory", "C:\Users\noahv\Documents\GitHub\create-python-server\clickup-operator", "run", "clickup-operator" ] } } ```已发布的服务器配置
``` "mcpServers": { "clickup-operator": { "command": "uvx", "args": [ "clickup-operator" ] } } ```💻 使用示例
基础用法
uv --directory C:\Users\noahv\Documents\GitHub\clickup-operator run clickup-operator
此命令用于启动 ClickUp 操作器 MCP 服务器。
📚 详细文档
构建和发布
为了准备分发包,可按以下步骤操作:
- 同步依赖项并更新锁定文件:
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。
您可以通过以下命令启动 MCP Inspector:
npx @modelcontextprotocol/inspector uv --directory C:\Users\noahv\Documents\GitHub\create-python-server\clickup-operator run clickup-operator
启动后,Inspector 会显示一个 URL,您可以将其在浏览器中打开以开始调试。
⚠️ 重要提示
发布到 PyPI 时,需要通过环境变量或命令行标志设置 PyPI 资格凭证。
💡 使用建议
调试 MCP 服务器时,推荐使用 MCP Inspector 以获得最佳调试体验。
微信扫一扫