使用说明
项目简介
my-mcp-claude 是一个基于 Model Context Protocol (MCP) 实现的服务器,它演示了如何构建一个能够为大型语言模型(LLM)提供上下文信息的后端应用。该服务器提供了一个简单的备忘录(note)管理系统,展示了 MCP 服务器的核心功能:资源管理、Prompt 模板和工具注册与执行。
主要功能点
- 资源 (Resources):
- 将备忘录存储为资源,并使用自定义 'note://' URI 方案进行访问。
- 每个备忘录资源包含名称、描述和 'text/plain' MIME 类型。
- 客户端可以列出和读取备忘录资源。
- Prompt 模板 (Prompts):
- 提供一个 'summarize-notes' Prompt 模板,用于总结所有备忘录的内容。
- 该 Prompt 接受可选的 'style' 参数('brief' 或 'detailed'),以控制总结的详细程度。
- 服务器根据当前备忘录和 style 参数动态生成 Prompt 内容。
- 工具 (Tools):
- 实现一个 'add-note' 工具,用于向服务器添加新的备忘录。
- 该工具接受 'name' 和 'content' 两个字符串参数。
- 工具执行后,服务器状态更新,并通知客户端资源已更改。
安装步骤
该项目是一个 Python 项目,推荐使用 'uv' 包管理器进行依赖管理和运行。(请确保已安装 uv,安装方法请参考 uv 官方文档)
-
克隆仓库
git clone https://github.com/dongju93/my-mcp-claude.git cd my-mcp-claude -
同步依赖
uv sync
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),您需要提供服务器的启动命令和参数。以下配置信息为 JSON 格式,需要添加到 MCP 客户端的配置文件中。
对于 Claude Desktop:
- MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
打开 'claude_desktop_config.json' 文件,在 '"mcpServers"' 字段下添加一个新的服务器配置。您可以选择 "my-mcp-claude" 作为服务器名称。
开发/未发布服务器配置示例
"mcpServers": { "my-mcp-claude": { "command": "uv", "args": [ "--directory", "/path/to/my-mcp-claude", // 将 "/path/to/my-mcp-claude" 替换为您的 my-mcp-claude 仓库的实际路径 "run", "my-mcp-claude" ] } }
配置参数说明:
- '"command"': 启动服务器的命令,这里使用 'uv' 包管理器来运行 Python 应用。
- '"args"': 传递给 'command' 的参数列表。
- '"--directory"': 指定项目目录,需要替换为您的 'my-mcp-claude' 仓库的实际路径。
- '"run"': 'uv' 的子命令,用于运行 Python 包。
- '"my-mcp-claude"': 要运行的 Python 包名称,对应项目中的 'my_mcp_claude' 包。
注意: 请务必将 '/path/to/my-mcp-claude' 替换为您本地 'my-mcp-claude' 仓库的绝对路径。
基本使用方法
-
启动服务器: 配置完成后,当 MCP 客户端(如 Claude Desktop)尝试连接到名为 "my-mcp-claude" 的 MCP 服务器时,将使用您在配置文件中提供的命令和参数来启动服务器。通常,客户端会在需要使用 MCP 功能时自动启动服务器。
-
与 MCP 客户端交互: 您无需直接与服务器交互。服务器在后台运行,并通过标准输入/输出 (stdio) 与 MCP 客户端通信。您可以通过 MCP 客户端的功能来体验该 MCP 服务器提供的备忘录管理功能,例如:
- 在客户端中触发 "summarize-notes" Prompt,让 LLM 总结您添加的备忘录。
- 在客户端中调用 "add-note" 工具,添加新的备忘录。
- 客户端可能会展示可用的备忘录资源供您访问。
-
调试 (可选): 如需调试 MCP 服务器,可以使用 MCP Inspector 工具。按照 README.md 中的 "Debugging" 部分的说明操作,可以帮助您监控和调试服务器与客户端之间的通信。
通过以上步骤,您就可以配置和使用 my-mcp-claude MCP 服务器,体验其提供的备忘录管理功能。
信息
分类
生产力应用