MD Planner MCP 服务器
使用说明(Markdown 格式)
项目简介
- MD Planner 内置一个基于 MCP(Model Context Protocol)的后端服务,提供资源、工具和 Prompt 模板等能力,旨在让大语言模型或其他 AI 客户端以统一的 JSON-RPC/HTTP 方式访问和操作本地项目数据。
主要功能点
- 资源托管与访问:提供 project、tasks、notes、goals 等资源的统一访问接口,便于 AI 客户端获取项目数据。
- 工具注册与调用:通过 MCP 工具注册,将任务、笔记、目标、会议、人员、投资等领域的操作暴露为可调用的工具,支持参数校验、结果封装与错误处理。
- HTTP/stdio 传输支持:支持通过标准输入输出和 Web HTTP 转运输的方式与客户端进行通信,便于本地开发、 Claude Desktop 等场景集成。
- 会话与权限控管:可在需要时启用 Bearer Token 验证、只读模式等,增强安全性与可控性。
- Brain/模型集成与扩展:提供 Brain Registry、MCP 资源、工具等扩展点,方便对接外部 AI 模型与服务。
安装与运行步骤
- 依赖与环境
- 需要运行在 Deno 环境的本地开发/部署环境,版本需兼容仓库中使用的 Deno API。
- 启动方式(命令行方式)
- 使用仓库提供的 MCP 启动入口运行指定项目的 MCP 服务,例如针对某个已有的 Markdown 项目目录启动。
- 常见启动方式是通过仓库提供的管理任务来启动 MCP 服务器,传入包含项目根目录的参数。
- 运行要点
- MCP 服务器会为指定的项目暴露资源、工具和配置接口,客户端需要指向对应的启动入口(HTTP 端点或 STDIO 传输入口)。
- 如果需要远程访问,将通过配置前置代理或头部鉴权实现访问控制。
服务器配置(供 MCP 客户端参考) 以下信息用于 MCP 客户端在 Claude Desktop 等环境中注册对接信息(配置为 JSON,客户端不需要额外的代码):
- server: mdplanner
- command: /path/to/mdplanner-mcp
- args: ["/path/to/your/project"]
注释说明
- server: 指定服务器名称,应该与实现中注册的 MCP 服务名称保持一致。
- command: 指向实际执行 MCP 服务的可执行文件路径(例如 mdplanner-mcp 二进制或等效入口脚本)。
- args: 传递给 MCP 服务器的参数,通常是包含要暴露 MCP 服务的项目目录。
基本使用方法
- 连接与调用
- 通过 MCP 客户端建立连接后,可以请求资源(如读取 project、tasks、notes 等 JSON 形式的数据)、调用已注册的工具(如 list_tasks、get_task、create_task、update_task 等操作)、以及获取或渲染 Prompt 模板。
- 数据流与安全
- 资源与工具的返回格式统一为 JSON-RPC 风格的响应;若使用 Bearer Token 进行鉴权,请在请求头中携带 Authorization: Bearer <token>。
- 常见场景
- 使用工具查询任务或笔记,辅助生成代码、文档或计划。
- 通过资源端点将本地数据暴露给云端 AI 客户端进行上下文增强。
注意事项
- 本仓库的 MCP 实现为本地化、可自托管的后端,适用于离线/可信网络环境。
- 启用缓存、备份、WebDAV 等特性时,请按实际需求配置相应参数与密钥管理策略。