✨ IntelliPlan MCP

🚀 转变您的开发工作流

IntelliPlan是一个智能任务管理系统，能够无缝集成到Cursor AI中的模型上下文协议（MCP）以及其他兼容编辑器中。它使您能够在不离开编码环境的情况下，通过结构化的Epic → 任务 → 子任务层次来组织您的开发过程。

✅ IntelliPlan能为您做什么？

轻松组织复杂项目

• Epic创建与管理 - 将复杂的项目分解为可管理的高层次目标
• 任务与子任务组织 - 通过清晰的父子关系结构化您的工作
• 智能依赖关系 - 定义并跟踪工作项之间的关系

加速开发计划

• AI辅助拆分 - 自动将复杂任务拆分为可管理的部分
• 智能实施建议 - 获取如何应对挑战的指导
• 复杂性分析 - 在深入之前了解所需的工作量

保持团队进度

• 进度跟踪 - 监控所有层级的完成状态
• 下一步行动推荐 - 始终知道接下来要做什么
• 上下文理解 - 获取涵盖整个工作范围的摘要

无缝编辑器集成

• 自然语言界面 - 使用对话命令与IntelliPlan交互
• 保持在您的工作流程中 - 无需在工具之间切换上下文
• MCP协议支持 - 支持任何实现模型上下文协议的编辑器

📋 可用工具

IntelliPlan提供了一套强大的工具来管理您的开发过程：

🎮 使用示例

设置项目存储

@IntelliPlanMCP manageItems action=configure basePath="/path/to/your/project"

创建新的Epic

@IntelliPlanMCP createEpic description="使用JWT构建用户认证系统"

向Epic添加任务

@IntelliPlanMCP manageItems action=createTask epicId=your-epic-id description="实现登录端点"

列出所有Epic，默认排序和过滤

@IntelliPlanMCP listEpics basePath="/path/to/your/project"

列出带有自定义过滤和排序的Epic

@IntelliPlanMCP listEpics statusFilter="in-progress" sortBy="completion" sortOrder="desc" limit=10

获取所有Epic的概览

@IntelliPlanMCP manageItems action=listEpics

通过单个操作创建带有嵌套任务的完整Epic

@IntelliPlanMCP batchEpic description="多租户用户认证" basePath="/path/to/project" tasks=[...]

获取特定图表类型的Epic概览

@IntelliPlanMCP getEpicOverview epicId=your-epic-id basePath="/path/to/project" diagramTypes=["progressPie", "dependencyGraph", "userJourney"]## 可用图表 🚧

注意： 图表功能目前仍在开发中 (WIP) 🚧

getEpicOverview 工具支持多种 Mermaid 图表类型，以可视化您的史诗结构和进度：

您可以使用 diagramTypes 参数数组指定要包含哪些图表。如果未指定，则当 includeDiagrams 设置为 true 时，将包含所有图表类型。

🐳 Docker 部署

IntelliPlan 可以使用 Docker 进行部署，以便于设置和管理。Docker 部署同时支持本地和远程存储模式。

构建 Docker 镜像

bash

构建 Docker 镜像

docker build -t intelliplan-mcp .

使用 Docker 运行

bash

创建一个目录来持久化数据

mkdir -p .intelliplan-data

使用本地卷挂载运行容器

docker run -d
--name intelliplan-mcp
-v $(pwd)/.intelliplan-data:/data
-p 4007:4007
intelliplan-mcp

存储配置选项

在 Docker 中运行 IntelliPlan 时支持两种存储模式：

1. 远程模式（默认）

在远程模式下，文件存储在挂载到容器 /data 目录的持久卷中：

bash
docker run -d
--name intelliplan-mcp
-v $(pwd)/.intelliplan-data:/data
-e STORAGE_MODE=remote
-e STORAGE_PATH=/app
-e RUNNING_IN_DOCKER=true
-p 4007:4007
intelliplan-mcp

这是推荐的 Docker 部署配置。所有数据将存储在主机上的 .intelliplan-data 目录中。

2. 本地模式

如果您希望使用本地存储模式，可以覆盖环境变量：

bash
docker run -d
--name intelliplan-mcp
-v $(pwd)/.intelliplan-data:/data
-e STORAGE_MODE=local
-e STORAGE_PATH=/data
-e RUNNING_IN_DOCKER=true
-p 4007:4007
intelliplan-mcp

Docker Compose 示例

为了更方便地管理，您可以使用 Docker Compose：

yaml
version: 3
services:
intelliplan-mcp:
build: .
container_name: intelliplan-mcp
volumes:
- ./.intelliplan-data:/data
environment:
- STORAGE_MODE=remote
- STORAGE_PATH=/app
- RUNNING_IN_DOCKER=true
ports:
- "4007:4007"
restart: unless-stopped

将此保存为 docker-compose.yml 并运行：

bash
docker-compose up -d

🔄 远程服务器模式

IntelliPlan 现在支持远程服务器模式，允许您将史诗和任务存储在集中式服务器上，而不是直接存储在本地文件系统上。这使得团队协作成为可能，并且可以从多个设备访问您的计划数据。

📡 设置远程服务器

1. 启动 API 服务器：
   bash

   设置配置的环境变量或使用默认值

   npm run start:api

2. API 服务器的环境变量：

   • PORT：运行服务器的端口（默认：3000）
   • STORAGE_PATH：API 服务器将存储数据的位置（默认：当前目录）

🔌 连接到远程服务器

1. 简单配置：

   最少只需要设置：
   bash
   STORAGE_MODE=remote

   默认情况下，这将连接到运行在 http://localhost:4007 的服务器。2. 高级配置（可选）:
   bash
   STORAGE_MODE=remote
   REMOTE_API_URL=http://your-server:4007 # 自定义服务器URL
   REMOTE_API_KEY=your-api-key # 如果启用了身份验证

2. 以远程模式启动IntelliPlan:
   bash
   npm run dev

3. 在Cursor中配置: 将以下内容添加到您的.cursor-settings.json文件中:
   json
   {
   "mcpServers": {
   "IntelliPlanMCP": {
   "command": "node",
   "args": ["path/to/dist/index.js"],
   "env": {
   "STORAGE_MODE": "remote"
   }
   }
   }
   }

🛡️ 安全注意事项

• API服务器包括基本的速率限制和CORS保护
• 对于生产环境使用，建议添加：
  • HTTPS加密
  • 强认证
  • 更强大的输入验证
  • 数据备份解决方案

📋 使用listEpics进行史诗管理

新的listEpics工具提供了一种方便的方式来查看和管理您IntelliPlan工作区中的所有可用史诗。

🔍 过滤和排序选项

listEpics工具支持以下参数：

📊 输出格式

该工具返回一个格式化的表格，包含以下列：

• 史诗ID
• 描述
• 状态（带视觉指示器）
• 任务完成情况（已完成/总数）
• 完成百分比

🚀 示例用法

基本用法：

@IntelliPlanMCP listEpics

带有过滤和排序：

@IntelliPlanMCP listEpics statusFilter="in-progress" sortBy="completion" sortOrder="desc" limit=5

当存储未配置时：

@IntelliPlanMCP listEpics basePath="/path/to/your/project"

🛠️ 入门指南

1. 安装IntelliPlan:

   npm install
   npm run build

2. 在Cursor中配置: 将以下内容添加到您的.cursor-settings.json文件中:
   json
   {
   "mcpServers": {
   "IntelliPlanMCP": {
   "command": "node",
   "args": ["path/to/dist/index.js"],
   "env": {
   "STORAGE_MODE": "remote"
   }
   }
   }
   }

3. 启用并开始规划: 在编辑器设置中激活MCP，并开始组织您的开发过程！

📝 自定义规划过程

IntelliPlan通过JSON配置文件支持可定制的规划过程：

1. 创建配置文件:
   您可以将JSON配置文件放置在项目的任何位置。建议使用config/planning/目录来组织，但这不是必须的。请参阅config/sample-planning-config.json示例。

2. 使用配置构建器:
   IntelliPlan提供了一个交互式工具来创建规划配置：

   @IntelliPlanMCP createPlanningConfig currentStep=0

   这将引导您逐步定义自定义规划步骤。

3. 直接创建配置:
   对于更高级用户，您可以直接创建配置：

   @IntelliPlanMCP createDirectPlanningConfig name="Custom Plan" description="Your custom planning process" outputPath="config/your-config.json" steps=[...]

4. 配置结构:
   json
   {
   "id": "your-plan-id",
   "name": "您的计划名称",
   "description": "您的规划过程描述",
   "version": "1.0",
   "defaultMaxDepth": 3,
   "includeTestStrategy": true,
   "steps": [
   {
   "id": "step-id",
   "name": "步骤名称",
   "description": "步骤描述",
   "order": 0,
   "instructions": ["指令1", "指令2"],
   "thinkingPrompts": ["思考提示1", "思考提示2"],
   "nextStepPrompt": "下一步指导",
   "requiresPreviousStepData": false
   }
   // 更多步骤...
   ]
   }5. 使用自定义配置:

   @IntelliPlanMCP planEpic description="您的项目" configPath="完整路径/到/您的/config.json"

5. LLM生成的配置:
   配置路径不必指向一个现有的文件。语言模型可以根据您的需求即时生成自定义规划配置。只需让LLM为您的特定需求创建一个规划配置，它就会为您生成合适的JSON配置。

🔍 为什么选择IntelliPlan？

与传统的任务管理工具不同，IntelliPlan直接在您的开发环境中工作。这种集成消除了上下文切换，并使您的规划与实现紧密结合。

IntelliPlan的人工智能能力不仅限于简单的任务跟踪 - 它理解您项目的结构，并提供关于实现、测试策略和复杂性分析的智能建议。

📄 许可证

MIT