使用说明
项目计划器MCP服务器
MCP(模型上下文协议)服务器,通过GitHub集成将应用程序想法转化为全面的、TDD驱动的、基于会话的实施计划。
哲学
规划是瓶颈,而不是编码。 糟糕的计划会导致项目失败。好的计划能够使代理执行成功。
此MCP服务器专注于创建全面、可执行的计划,AI代理可以遵循这些计划来构建您的应用程序,并与GitHub完全集成以进行跟踪和进度管理。
特性
🎯 智能规划
- 人工智能驱动的发现 -提出战略问题以了解您的应用程序要求
- 基于模板的生成 -常见应用类型(博客、电子商务、SaaS等)的预构建模板
- 定制规划 -根据独特需求从头开始构建
- TDD执行 -每节课都遵循RED-GREEN-REFACTOR循环
🐙 GitHub集成
- 自动设置 -从计划中创建问题、里程碑和标签
- 进度跟踪 -GitHub问题状态的实时指标
- 会话管理 -每个会话=1个GitHub问题,具有完整的TDD工作流程
- 里程碑跟踪 -每个阶段=1个GitHub里程碑
🧠 跨项目情报
- 模式学习 -从过去的项目中学习,以改进估算
- 建筑评论 -分析技术可行性要求
- 工作量估算 -基于历史数据的智能时间估算
📊 基于会话的执行
- 上下文优化 -会话大小可避免AI上下文疲劳
- 明确退出标准 -确切地知道会话何时完成
- 依赖管理 -实施任务的正确排序
快速开始
安装
选项1:npm(推荐)
从npm安装: 项目规划师mcp
npm install -g project-planner-mcp
选项2:npx(不安装)
直接与npx一起使用-无需安装。
选项3:来源
git clone https://github.com/hmesfin/pm-mcp.git
cd pm-mcp/mcp-plan
npm install
npm run build
配置
克劳德代码
添加到您的克劳德代码设置(~/.claude.json 在Linux/Mac上):
使用npx(推荐):
{
"mcpServers": {
"project-planner": {
"type": "stdio",
"command": "npx",
"args": ["-y", "project-planner-mcp"],
"env": {
"GITHUB_TOKEN": "your-github-token"
}
}
}
}
使用全局安装:
{
"mcpServers": {
"project-planner": {
"type": "stdio",
"command": "project-planner-mcp",
"env": {
"GITHUB_TOKEN": "your-github-token"
}
}
}
}
克劳德桌面
添加到Claude桌面配置(~/Library/Application Support/Claude/claude_desktop_config.json 在Mac上):
{
"mcpServers": {
"project-planner": {
"command": "npx",
"args": ["-y", "project-planner-mcp"],
"env": {
"GITHUB_TOKEN": "your-github-token"
}
}
}
}
GitHub代币
在以下网址获取个人访问令牌https://github.com/settings/tokens
所需范围:
repo(all)-用于创建问题、里程碑、标签read:org(可选)-用于组织项目
基本用法
-
根据需求生成计划
Use the generateProjectPlan tool with your REQUIREMENTS.md -
设置GitHub项目
Use the setupGitHubProject tool to create issues and milestones -
追踪进度
Use the trackProgress tool to see completion metrics
看 docs/PLANNING_GUIDE.md 了解详细的使用说明。
项目结构
project-planner-mcp/
├── mcp-plan/ # MCP server implementation
│ ├── src/
│ │ ├── tools/ # MCP tool implementations
│ │ ├── services/ # Business logic
│ │ └── types/ # TypeScript type definitions
│ ├── index.ts # MCP server entry point
│ └── REQUIREMENTS.md # MCP server requirements
├── project-plans/ # Generated plans (output)
│ └── <your-app>/
│ ├── REQUIREMENTS.md
│ ├── PROJECT_PLAN.md
│ └── .agent-state.json
├── templates/ # Plan generation templates
│ ├── blog/
│ ├── ecommerce/
│ ├── saas/
│ ├── social/
│ ├── projectmanagement/
│ ├── PROJECT_PLAN_TEMPLATE.md
│ └── PHASE_TASKS_TEMPLATE.md
├── docs/ # Documentation
│ ├── PLANNING_GUIDE.md # User guide
│ └── archive/ # Old implementation (reference)
└── CLAUDE.md # Project documentation for Claude Code
MCP工具
规划工具
- 传导发现 -互动问答以收集需求
- 生成项目计划 -根据需求创建PROJECT_PLAN.md
- 分析需求 -解析并验证REQUIREMENTS.md
- 评论计划 -审查问题和改进计划
GitHub集成工具
- setupGitHubProject -创建问题、里程碑、标签
- 跟踪进度 -查询GitHub以获取进度指标
- 与GitHub同步 -将本地状态与GitHub同步
- findNextSession -获取下一个可用会话以进行处理
- 下载状态 -将会话标记为已开始/已完成
情报工具
- 架构回顾 -技术可行性分析
- 估计努力 -时间和复杂性估计
TDD执行
每节课都遵循RED-GREEN-REFACTOR循环:
-
🔴 红相:首先编写失败的测试
- 预期结果:❌ 测试失败(实现不存在)
-
🟢 绿色阶段:编写最少的代码以通过测试
- 预期结果:✅ 测试通过
-
🔵 REFACTOR阶段:在保持测试通过的同时进行优化
- 预期结果:✅ 重构后测试仍然通过
会话大小
会话的大小是为了避免上下文疲劳:
- 基本应用程序:约15K令牌/会话(剩余30K+缓冲区)
- 中级应用程序:约18K令牌/会话(剩余30K+缓冲区)
- 高级应用程序:约20K令牌/会话(剩余30K+缓冲区)
GitHub集成
MCP创建了一个完整的GitHub项目结构:
标签(共16个)
- 阶段标签:
phase-1通过phase-5 - 域名标签:
backend,frontend,mobile,e2e,infrastructure - TDD阶段标签:
red-phase,green-phase,refactor-phase - 状态标签:
in-progress,blocked,ready-for-review
里程碑(每个阶段1个)
- 第一阶段:核心基础设施
- 第二阶段:功能实现
- 第三阶段:集成与测试
- 第4阶段:抛光和优化
- 第5阶段:文件编制和部署
问题(每届会议1个)
每期包括:
- 🎯 目标
- 🔴 RED阶段任务
- 🟢 绿色阶段任务
- 🔵 REFACTOR阶段任务
- ✅ 退出标准检查表
- 📊 元数据(估计值、依赖关系)
工作流示例
// 1. Generate a plan from requirements
const plan = await generateProjectPlan({
requirementsPath: "path/to/REQUIREMENTS.md",
outputDir: "project-plans/my-app"
});
// 2. Setup GitHub project
const github = await setupGitHubProject({
planPath: "project-plans/my-app/PROJECT_PLAN.md",
owner: "yourusername",
repo: "your-repo"
});
// 3. Track progress
const progress = await trackProgress({
owner: "yourusername",
repo: "your-repo",
planPath: "project-plans/my-app/PROJECT_PLAN.md"
});
console.log(`Completed: ${progress.completedSessions}/${progress.totalSessions}`);
console.log(`Current phase: ${progress.currentPhase}`);
发展
# Build
npm run build
# Watch mode
npm run watch
# Type checking
npm run type-check
# Format
npm run format
从Slash命令迁移
此MCP服务器取代了旧的基于斜线命令的计划系统。看 docs/archive/MIGRATION.md 获取迁移说明。
主要区别:
- MCP工具 而不是斜线命令
- GitHub集成 用于进度跟踪
- 跨项目情报 使用SQLite数据库
- 更好的模块化 使用TypeScript服务
内部测试
这个MCP服务器是计划好的,正在使用它自己构建!看 项目计划/mcp服务器/ 对于我们正在遵循的计划。
查看实际的GitHub项目: https://github.com/hmesfin/pm-mcp
贡献
欢迎投稿!看 mcp计划/要求.md 完整的规格说明。
许可证
麻省理工学院
支持
- 文档: docs/PLANNING_GUIDE.md
- 问题: https://github.com/hmesfin/pm-mcp/issues
- 建筑: CLAUDE.md
准备好规划你的应用程序了吗? 安装MCP服务器并开始构建! 🚀
