DevPlanner 模型上下文协作服务器

使用说明(简要可操作要点,以下内容为Markdown格式,便于阅读)

  • 项目简介

    • 该仓库实现了一个基于模型上下文协议(MCP)的服务器端,旨在为AI代理提供标准化的上下文信息与功能入口。核心能力包括托管与管理资源(Resources)、注册与执行工具(Tools)、以及定义/渲染提示模板(Prompts)。服务器通过JSON-RPC与客户端对话,支持多种传输方式,当前实现提供标准的stdio传输。
  • 主要功能点

    • 17 个工具工具(CRUD、智能工作流、数据查询等),用于对 DevPlanner 数据进行创建、查询、更新、移动、任务管理、卡片内容替换等操作。
    • 3 种资源只读入口,便于AI代理获取项目信息、卡片摘要等,只读数据不暴露修改入口。
    • 详细的 JSON Schema,确保工具输入的结构化校验与可解释的错误信息。
    • 通过标准的stdio传输启动 MCP 服务器,便于与 Claude Code、GitHub Copilot 等AI代理集成。
    • 错误处理与类型定义完善,支持LLM友好错误描述。
    • 与 DevPlanner 的后端数据/文件系统紧密集成,具备会话、历史、WebSocket 实时广播等协作能力的配套实现。
  • 安装步骤

    • 确保运行环境已安装 Bun。
    • 获取代码后进入仓库根目录。
    • bun install
    • 在工作区目录中创建或指定 DEVPLANNER_WORKSPACE,确保工作区可写。
    • 启动 MCP 服务器:
      • 指定工作区路径后执行:bun run mcp
    • 注意:前端/后端其他服务在该仓库中并非 MCP 的必需部分,但整体项目提供Kanban后端、前端、以及MCP对接能力。
  • 服务器配置(MCP 客户端需要的配置信息示例说明)

    • 以下为JSON格式的配置信息描述,用于MCP客户端在启动阶段连接并调用DevPlanner的MCP服务器:
    • server name: devplanner
    • command: bun
    • args: ["run", "mcp"]
    • env: DEVPLANNER_WORKSPACE: 绝对路径指向本地工作区目录 注:以上信息用于MCP客户端的启动配置,客户端本身不需要改动代码,仅在集成时按此格式提供给客户端。
  • 基本使用方法

    • 启动:在仓库根目录执行 bun run mcp(须先设置 DEVPLANNER_WORKSPACE 指向工作区路径)
    • 调用方式:通过MCP客户端向服务器发送JSON-RPC请求,调用工具、读取资源或获取提示模板等。
    • 服务器端实现涵盖:工具执行、资源提供、以及错误处理等核心能力,所有响应以JSON-RPC格式返回给客户端。
    • 运行阶段的日志与调试信息可帮助排查请求/响应流程问题。
  • 备注与适用场景

    • 该实现可在AI代理与DevPlanner之间建立强力的上下文/能力对接,适用于需要以标准化接口访问项目数据、执行工作流工具、以及查看/渲染提示模板的AI驱动工作流。

服务器信息