AI导哈

项目管理协议服务器

HacknPlan MCP Server是一个基于Node.js的模型上下文协议服务器，提供HacknPlan项目数据和精选文档片段给MCP客户端，适用于项目管理、团队协作和开发流程自动化。

  • by SaViGnAnO
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 SaViGnAnO/hacknplan-mcp

使用说明

HacknPlan MCP服务器

Node.js模型上下文协议（MCP）服务器，向MCP客户端提供HacknPlan项目数据和精心策划的文档片段。

特性

  • get_board_summary 加 list_work_items 使用项目范围的过滤器（董事会、里程碑、阶段、受让人、文本搜索）。
  • 高级板/冲刺工具：列出/创建/更新/关闭/重新打开板，并将未完成的工作滚动到后续冲刺中。
  • 里程碑生命周期助手（列表/创建/更新/关闭/重新打开），包括级联的板/任务关闭控件。
  • 工作项CRUD：创建/更新/删除项目、获取详细信息、移动阶段、切换完成和管理评论。
  • 分配和标记助手，用于快速添加/删除卡片上的用户或标签。
  • CLI/API-key验证，支持 HACKNPLAN_API_KEY env变量或a --api-key 旗帜。
  • 静态文档资源来源于 docs/knowledge/ 并通过暴露 hacknplan-doc:// URI。

先决条件

  • Node.js 20+
  • HacknPlan API密钥存储在 .env (HACKNPLAN_API_KEY=...)或在运行时通过 --api-key YOUR_KEY.

脚本

命令 目的
npm run build 将TypeScript编译为 build/.
npm run start -- --api-key YOUR_KEY 通过stdio启动MCP服务器。
npm run lint / npm run lint:fix ESLint采用扁平配置。
npm run format / npm run format:check 预格式化。
npm run test / npm run test:watch Vitest单元测试（客户端+工具处理程序）。
npm run test:live 使用API密钥对HacknPlan进行实时烟雾测试 .env.
npm run typecheck TypeScript类型只能通过

活烟测试

使用 npm run test:live 使用您的本地配置来达到真正的HacknPlan API HACKNPLAN_API_KEY该脚本列出每个项目，选择第一个活动项目（如果所有项目都已关闭，则选择第一个条目），然后列出电路板并选择第一个打开的电路板进行只读检查。可选覆盖：

  • --project-id <id>：将流固定到特定项目，而不是自动选择。
  • --board-id <id>：针对特定的董事会；默认为API返回的第一个开板。
  • --limit <n>：要获取的工作项数（默认值为5）。
  • --include-closed-boards：自动选择时允许关闭板。

该脚本仍然是只读的：它列出了电路板，提取了一些工作项，获取了第一个项目的详细有效载荷，并列出了里程碑，这样你就可以在不连接MCP客户端的情况下确认实时访问。

MCP配置示例

将服务器添加到MCP客户端配置中（例如，Claude Desktop的 claude_desktop_config.json)跑步后 npm run build 一次：

{
  "mcpServers": {
    "hacknplan": {
      "command": "npm",
      "args": [
        "run",
        "start",
        "--",
        "--api-key",
        "${env:HACKNPLAN_API_KEY}"
      ],
      "cwd": "d:/Projects/hacknplan-mcp",
      "env": {
        "HACKNPLAN_API_KEY": "your-real-api-key"
      }
    }
  }
}
  • command 通过以下方式启动编译后的服务器 npm run start，传递预期的API密钥标志 src/config.ts.
  • cwd 应指向HacknPlan MCP所在的文件夹。如果您通过VS code扩展或其他地方安装此代码，请更新 cwd 到该位置或交换到显式 command 例如 node 加上绝对路径 build/index.js.
  • 您可以将密钥内联 env （如上所述）或依赖于现有的系统环境变量，只要 HACKNPLAN_API_KEY 当客户端生成服务器时设置。

文件提供商

内容存在于 docs/knowledge/*.md每个文件描述了HacknPlan API能力，并引用了上游文档。在启动期间，服务器注册MCP资源（例如。， hacknplan-doc://board-summary).客户端可以读取这些URI，以便在工具响应的同时嵌入有用的API上下文。

开发流程

  1. 安装依赖项： npm install.
  2. 复制 .env.example （创建一个）或设置 HACKNPLAN_API_KEY 用于本地测试。
  3. 跑 npm run build && npm run test && npm run lint 在打开PR之前。
  4. 更新 PLAN.md 随着里程碑的进展，并在引用新的API行为时添加新的知识库片段。

相关 MCP