使用说明
项目简介
本项目是一个基于Model Context Protocol (MCP) 的服务器实现,旨在演示如何在树莓派等设备上搭建MCP服务器,为大型语言模型 (LLM) 客户端提供上下文信息和功能扩展。该服务器提供简单的笔记管理功能,包括创建、存储和总结笔记,通过资源、Prompt 和工具等 MCP 核心概念进行功能实现。
主要功能点
- 资源 (Resources): 实现了简单的笔记存储系统,每篇笔记作为一个资源,可以通过自定义 'note://' URI scheme 进行访问。
- Prompt 模板 (Prompts): 提供了一个 'summarize-notes' Prompt,用于生成所有笔记的摘要,并支持可选的 'style' 参数(brief/detailed)来控制摘要的详细程度。
- 工具 (Tools): 实现了一个 'add-note' 工具,允许客户端向服务器添加新的笔记,添加成功后服务器会更新状态并通知客户端资源已变更。
安装步骤
本仓库已包含服务器的完整代码,无需额外安装服务器程序。安装步骤主要指配置MCP客户端以连接到本服务器。
以下以 Claude Desktop 为例说明如何配置 MCP 客户端连接到本服务器 (假设您已将本仓库代码下载到本地):
-
找到 Claude Desktop 配置文件:
- MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
-
编辑配置文件: 打开 'claude_desktop_config.json' 文件,在 JSON 对象的 '"mcpServers"' 字段下添加本服务器的配置信息。如果 'mcpServers' 字段不存在,请手动创建。
服务器配置
以下是添加到 'claude_desktop_config.json' 中 'mcpServers' 字段的服务器配置信息 (JSON 格式):
"mcpServers": { "mcp-server-on-raspi": { "command": "uv", "args": [ "run", "mcp-server-on-raspi" ] } }
配置参数说明:
- '"mcp-server-on-raspi"': 服务器名称,您可以自定义,用于在客户端中标识该服务器。
- '"command": "uv"': 启动命令,指定用于启动服务器的命令。 'uv' 是一个快速的 Python 包安装和运行工具,这里假设您已安装 'uv' 并使用 'uv sync' 安装了项目依赖。 如果您使用 'python' 命令直接运行服务器脚本,此处应配置为 '"command": "python"'。
- '"args": ["run", "mcp-server-on-raspi"]': 命令参数,传递给启动命令的参数。 '["run", "mcp-server-on-raspi"]' 指示 'uv' 运行 'mcp-server-on-raspi' 包。 如果您使用 'python' 命令,参数可能需要指向服务器脚本的路径,例如 '["src/mcp_server_on_raspi/server.py"]'。 推荐使用 'uv run mcp-server-on-raspi',与仓库 README 保持一致。
注意: 以上配置假设您在仓库根目录下使用 'uv run mcp-server-on-raspi' 命令启动服务器。 您需要根据实际的服务器启动方式和脚本路径调整 'command' 和 'args' 参数。
基本使用方法
- 启动 MCP 服务器: 打开终端,进入仓库根目录,执行命令 'uv run mcp-server-on-raspi' 启动服务器。 确保已事先执行 'uv sync' 安装依赖。
- 启动 MCP 客户端: 启动您配置的 MCP 客户端 (例如 Claude Desktop)。
- 使用 MCP 功能: 客户端成功连接到服务器后,您应该可以在客户端界面中看到服务器提供的功能。例如,在 Claude Desktop 中,您可能会看到 "summarize-notes" Prompt 和 "add-note" Tool。您可以尝试使用 "add-note" 工具添加笔记,然后使用 "summarize-notes" Prompt 生成笔记摘要。
信息
分类
开发者工具