🚀 软件规划工具
一个基于模型上下文协议（MCP）设计的服务器，旨在通过互动、结构化的流程来促进软件开发规划。该工具可帮助将复杂的软件项目分解为易于管理的任务，跟踪实施进度，并维护详细的开发计划。
🚀 快速开始
使用此软件规划工具，您可以轻松地组织和管理软件开发项目。以下是基本的使用步骤：
- 安装依赖：
npm install
- 启动工具：
npm start
- 使用命令行交互：
start_planning "开发新功能模块"
add_todo {
title: "实现用户认证",
description: "为系统添加用户认证功能。",
complexity: 8
}
get_plan
update_plan {
status: "in_progress"
}
clear_plan
✨ 主要特性
- 互动规划会议：启动和管理开发规划会议
- 待办事项管理：创建、更新和跟踪开发任务
- 复杂度评分：为任务分配复杂度分数以进行更好估算
- 代码示例：在任务描述中包含相关代码片段
- 实施计划：保存并管理详细的实施计划
📦 安装指南
通过 Smithery 安装
要通过 Smithery 自动安装软件规划工具以用于 Claude Desktop：
npx -y @smithery/cli install @NightTrek/Software-planning-mcp --client claude
手动安装
- 克隆仓库
- 安装依赖项：
pnpm install
- 构建项目：
pnpm run build
- 添加到您的 MCP 设置配置文件中（通常位于
~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json）：
{
"mcpServers": {
"software-planning-tool": {
"command": "node",
"args": [
"/path/to/software-planning-tool/build/index.js"
],
"disabled": false,
"autoApprove": []
}
}
}
💻 使用示例
基础用法
以下是一些使用该工具的基本示例：
- 启动规划会议：
start_planning "开发新用户界面"
- 添加任务：
add_todo {
title: "设计主页布局",
description: "创建新的主页布局，确保用户体验流畅。",
complexity: 7
}
- 获取当前计划：
get_plan
- 更新计划：
update_plan {
timeline: {
phase1: "需求分析完成",
phase2: "设计阶段进行中"
}
}
- 清除计划：
clear_plan
高级用法
您可以根据项目的具体需求，灵活组合使用各个命令，以实现更复杂的项目管理。例如，在开发一个大型软件项目时，可以多次启动规划会议，逐步细化任务，并根据实际进度不断更新计划。
🔧 技术细节
项目的文件结构如下：
Software Planning Tool
├── src/
│ ├── storage.ts # 数据持久化
│ ├── types.ts # TypeScript 类型定义
│ └── utils.ts # 工具函数
├── build/ # 构建输出目录
└── package.json # 项目依赖和配置
📚 详细文档
可用工具
start_planning
以特定目标开始一个新的规划会议。
{
goal: string // 软件开发的目标
}
add_todo
向当前计划添加一个新的待办事项项。
{
title: string, // 待办事项项的标题
description: string, // 详细描述
complexity: number, // 复杂度：数字（0-10）
codeExample?: string // 可选：相关代码示例
}
get_plan
获取当前的实施计划。
{
plan: object // 当前的实施计划对象
}
update_plan
更新当前的实施计划。
{
updates: object // 要更新的内容
}
clear_plan
清除当前的实施计划。
clear_plan
📄 许可证
[此处插入许可证信息]
👥 联系方式
如需联系开发者，请发送邮件至 your.email@example.com。
👨💻 项目维护者
- John Doe - john.doe@example.com
- Jane Smith - jane.smith@example.com
🙏 感谢
感谢所有贡献者和用户的支持，使该项目得以成功。
这个工具旨在简化软件开发过程中的规划阶段，帮助团队更高效地组织和执行项目。希望它能为您的下一个项目带来便利！
⚠️ 重要提示
- 确保所有依赖已正确安装。
- 在生产环境中使用前，建议进行充分的测试。
- 如果遇到问题，请检查日志文件或查阅文档。
💡 使用建议
在使用该工具时，建议您根据项目的实际情况合理分配任务的复杂度，以便更准确地估算项目进度。同时，定期查看和更新计划，确保项目按预期进行。