使用说明(简明、可操作的要点)
-
项目简介
- 该仓库实现了一组 MCP 服务器(以 Claude Copilot 为核心目标)的一部分:内存管理与知识上下文服务的 copilot-memory、以及技能与知识仓库的 copilot-copilot/skills-copilot 等组件。服务器通过 MCP 的标准请求处理流程暴露工具、资源、以及对话上下文相关的数据与能力,支持多种传输方式(示例中以标准输入/输出为传输通道)。
-
主要功能点
- 内存与会话管理
- 提供内存存储、更新、删除、查询、按语义检索等能力,并对会话进行跟踪。
- 语义嵌入与向量检索
- 使用 Transformer 模型生成文本嵌入,支持基于嵌入向量的相似度检索。
- 计划/里程碑(Initiative)跟踪
- 启动、更新、获取、完成当前 Initiative,并以 Markdown 形式输出摘要。
- 资源与上下文生成
- 以 Markdown 形式渲染当前 Initiative、项目上下文等资源,便于在对话中作为上下文引用。
- MCP 工具注册与执行
- 通过 SetRequestHandler 提供 ListTools、CallTool 等接口,LLM 客户端可以枚举并调用服务端工具。
- 资源读取与列表示例
- 提供读取资源与资源列表的能力,帮助跨会话保留上下文信息。
- 持久化与数据库支持
- 使用 SQLite/ SQLite-Vec 实现本地化存储与向量近似搜索,支持简单的持久化与高效查询。
- 知识仓库扩展
- 提供知识仓库提供者,支持多层知识库(全局与项目级别),并支持扩展加载、扩展清单、知识搜索等。
- 内存与会话管理
-
安装与运行(简要步骤)
- 需要环境
- Node.js 18 及以上
- 依赖包在各 MCP 服务器模块中定义(如 copilot-memory、skills-copilot 等)
- 运行方式(示例)
- 直接通过 Node 运行入口(如 copilot-memory/src/index.ts)来启动服务器,代码中含有可直接执行的入口(带有 shebang),可按项目实际部署方式执行。
- 运行依赖
- 某些功能依赖本地数据库、向量模型和外部 API,请确保本地资源和网络环境就绪(如 PostgreSQL、SkillsMP 接入等配置)。
- 需要环境
-
服务器配置(客户端连接配置示例,MCP 客户端不需要此处代码)
- MCP 客户端在连接时需要知道服务器启动命令及参数,以便通过 JSON-RPC 向服务器发起请求。以下为示意性配置信息,描述服务器启动方式及参数,不作为代码直接执行。
- 配置项说明
- serverName: MCP 服务器的名称,客户端用于标识和路由请求。
- command: 启动服务器的命令(如 node)。
- args: 启动服务器的参数,指向具体的入口文件(如 copilot-memory/src/index.ts)。
- workingDirectory(可选): 服务器工作目录,通常为仓库根或运行环境中的具体路径。
- 示例(文本描述的 JSON 形式,非代码块展示) { "serverName": "copilot-memory", "command": "node", "args": ["./mcp-servers/copilot-memory/src/index.ts"], "workingDirectory": "/path/to/repo" }
- 说明
- 上述配置仅用于 MCP 客户端在调度与启动服务器时的定位与参数传递。实际部署时,请按实际运行环境提供相应的可执行入口与路径。
-
基本使用方法
- 启动与连接
- 在支持 MCP 的客户端环境中,按上述启动命令启动对应的 MCP 服务器实例(memory、skills 等)。
- 客户端通过 MCP 标准请求(如 ListTools、CallTool、ListResources、ReadResource 等)与服务器交互,获得工具、资源、以及对话上下文能力。
- 常用交互模式
- 枚举工具:请求 ListTools,获取可用工具清单(如 memory_store、memory_get、initiative_start 等)。
- 调用工具:请求 CallTool,传入工具名与参数,服务器执行并返回结果内容。
- 读取资源:通过 ListResources 获取可用资源清单,通过 ReadResource 读取具体内容(如当前 Initiative、项目上下文等)。
- 会话与记忆:对话中可调用 memory_store、memory_search 等,在本地数据库中持久化内容并进行语义检索。
- 期望行为
- 服务器应在标准 MCP 的请求-响应格式下返回结构化的内容(文本、Markdown、JSON 等),并在出现错误时返回明确的错误信息。
- 安全与扩展性
- 服务器设计考虑了会话、能力声明、以及多种传输方式(示例中以标准输入/输出传输为主),便于后续通过 WebSocket、SSE 等传输协议扩展。
- 启动与连接
-
备注
- 仓库内包含多套 MCP 服务器实现(如 copilot-memory、skills-copilot 等),均遵循 MCP 的核心交互定义,具备完整的服务器入口、工具/资源注册、以及 RAM/持久化能力,非单纯示例或测试代码。
信息
分类
AI与计算