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