pūrmemo MCP 服务器
使用说明(Markdown 格式)
- 项目简介
- 该仓库实现了一个 MCP(Model Context Protocol)服务器,核心职责是向 LLM 客户端提供结构化的上下文服务,包括:
- 资源管理:托管如“memory://me”、“memory://context”等资源,用于提供数据访问与上下文信息。
- 工具注册与执行:定义并暴露诸如 save_conversation、recall_memories、get_memory_details、discover_related_conversations 等工具,LLM 客户端可通过 JSON-RPC 调用执行。
- 提示模板渲染:提供 prompts(如 load-context、save-this-conversation、catch-me-up、weekly-review)以支持多种交互模式。
- 服务器通过 MCP 的标准 JSON-RPC 机制与客户端通信,具备会话管理、能力声明,以及对传输协议的支持(如 STDIO、SSE、WebSocket 等)。
- 主要功能点(简要直观说明)
- MCP 协议实现与路由
- 支持 ListResources、ReadResource 等资源相关请求
- 支持 ListTools、CallTool 等工具相关请求
- 支持 ListPrompts、GetPrompt 等 prompts 相关请求
- 资源、工具、提示的标准化管理
- 提供 memory://me、memory://context、memory://projects、memory://stats 等资源
- 提供 save_conversation、recall_memories、get_memory_details、discover_related_conversations 等工具
- 提供 load-context、save-this-conversation、catch-me-up、weekly-review 等 Prompts
- 会话与上下文
- 包含身份/会话上下文的注入与维护,支持多平台跨会话的上下文持久化
- 安全与健壮性
- 通过令牌存储、令牌刷新、错误处理与日志输出,尽量在失败时不阻塞主流程
- 多传输协议
- 设计上可拓展到 STDIO、SSE、WebSocket 等传输机制,以对接不同的 MCP 客户端
- 安装与运行步骤
- 安装
- 使用 npm/npx 直接运行提供的 MCP 服务器包(仓库内已有完整实现,包含入口与各模块)
- 运行
- 通过 MCP 客户端(如 Claude Code、Claude Desktop、Cursor、Windsurf 等)连接该 MCP 服务器
- 服务端需要一个有效的 API Key(PURMEMO_API_KEY)以访问 Purmemo 的后端接口
- 服务端与客户端的关系
- MCP 服务器是后端服务端,MCP 客户端通过配置指向该服务器并通过指定传输方式建立连接
- 配置通常包括 server 名称、启动命令及参数等信息,服务端提供标准的资源/工具/ prompts
- 服务器配置(给 MCP 客户端的连接配置示例,JSON 格式,仅供参考,实际客户端会按需要放在自己的配置中)
- server 名称示例:purmemo
- 启动命令示例(命令 + 参数):
- command: npx
- args: ["-y", "purmemo-mcp"]
- env: { "PURMEMO_API_KEY": "your-api-key-here" }
- 说明
- 该配置用于在 MCP 客户端中启动 Purmemo 的 MCP 服务器。MCP 客户端需要提供服务器名称、命令与参数来启动服务器进程,服务器将通过 MCP 协议与客户端进行通信。
- 具体示例(文本描述,不作为代码块展示):
- server name: purmemo
- command: "npx"
- args: ["-y", "purmemo-mcp"]
- env: { "PURMEMO_API_KEY": "your-api-key-here" }
- 基本使用方法
- 启动与连接
- 在客户端配置中指定上面的启动命令与参数,启动后客户端通过 MCP 协议与 Purmemo MCP 服务器建立会话
- 典型工作流
- 客户端请求读取资源或调用工具(如读取个人记忆、保存对话、查询相关记忆等)
- MCP 服务器返回 JSON/RPC 响应、或通过通知方式推送信息
- 适用场景
- 在 LLM 会话中嵌入持续上下文、通过工具扩展能力、通过 prompts 启动会话等
- 注意事项
- 确保 API Key 的安全存储与使用,避免将 Key 暴露在日志或公开环境中
- 根据客户端不同的传输能力,选择合适的传输方式(如 STDIO、SSE、WebSocket 等)
- 了解并遵循 MCP 客户端的版本与能力对齐,确保资源、工具、 prompts 的描述与输出格式符合 MCP 规范
- 额外信息
- MCP 服务器核心采用了 Model Context Protocol 的通用能力模型,具备资源/工具/ prompts 三大核心能力,且实现了对多种前端/IDE 客户端的接入支持
- 本仓库还配套提供了测试用例、示例工具注解、以及跨平台的验证用例,便于理解 MCP 服务端的行为与接口
-
关键词 模型上下文协议, 资源管理, 工具执行, 提示模板, JSON-RPC, 会话上下文
-
分类ID 1