✨ IntelliPlan MCP

铁匠徽章

IntelliPlan MCP 演示

🚀 转变您的开发工作流程

IntelliPlan 是一款智能任务管理系统，可与 Cursor AI 及其他兼容编辑器中的模型上下文协议 (MCP) 无缝集成。它使您能够通过结构化的“Epic → Task → Subtask”层级结构来组织开发流程，而无需离开您的编码环境。

✅ IntelliPlan 能为您做什么？

轻松组织复杂项目

史诗创作与管理——将复杂的项目分解为可管理的高级目标
任务和子任务组织- 通过清晰的父子关系构建您的工作
智能依赖关系- 定义和跟踪工作项之间的关系

增强发展规划

AI辅助分解——自动将复杂任务拆分为可管理的部分
智能实施建议- 获取应对挑战的指导
复杂性分析——了解深入研究之前所需的努力

让你的团队保持正轨

进度跟踪——监控各级完成情况
下一步行动建议——始终知道下一步该做什么
情境理解——获取涵盖全部工作范围的摘要

无缝编辑器集成

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

📋 可用工具

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

工具	描述
`batchEpic`	在一次操作中创建一个包含多个任务的完整 Epic，每个任务可能包含多个子任务。
`createEpic`	创建一个新的 Epic（顶级任务），其中包含计划详细信息和可选的初始任务创建。
`createPlanningConfig`	为 planEpic 工具创建一个 JSON 配置文件，允许自定义规划步骤和流程。
`executeItem`	执行或提供执行 Epic 或 Task 的指导。
`expandTask`	将任务或史诗分解为更小、可操作的子项目。
`getEpicOverview`	提供 Epic、其任务和相关信息的详细、易读的概述。
`listEpics`	列出所有可用的史诗，包括其 ID、描述、状态和完成情况。支持过滤和排序。
`manageItems`	通过各种操作（创建、更新、删除等）管理 Epics、任务和子任务。
`manageTaskStorage`	管理 Epics 和 Tasks 的存储配置和导出。
`planEpic`	通过顺序思考，以交互方式创建具有分层任务和子任务的详细实施计划，指导代理完成多个细化步骤。

🎮 使用示例

# Set up your project storage
@IntelliPlanMCP manageItems action=configure basePath="/path/to/your/project"

# Create a new epic
@IntelliPlanMCP createEpic description="Build user authentication system with JWT"

# Add a task to your epic
@IntelliPlanMCP manageItems action=createTask epicId=your-epic-id description="Implement login endpoint"

# List all epics with default sorting and filtering
@IntelliPlanMCP listEpics basePath="/path/to/your/project"

# List epics with custom filtering and sorting
@IntelliPlanMCP listEpics statusFilter="in-progress" sortBy="completion" sortOrder="desc" limit=10

# Get an overview of all your epics
@IntelliPlanMCP manageItems action=listEpics

# Create a complete epic with nested tasks in a single operation
@IntelliPlanMCP batchEpic description="Multi-tenant user authentication" basePath="/path/to/project" tasks=[...]

# Get an epic overview with specific diagram types
@IntelliPlanMCP getEpicOverview epicId=your-epic-id basePath="/path/to/project" diagramTypes=["progressPie", "dependencyGraph", "userJourney"]

可用图表🚧

**注意：**图表功能目前处于进行中状态（WIP）🚧

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

图表类型	描述
`progressPie`	显示已完成任务与剩余任务的圆形图
`dependencyGraph`	史诗和任务依赖关系的网络图
`taskFlow`	流程图按具有依赖关系的状态组织任务
`timeline`	显示任务时间表和持续时间的甘特图
`userJourney`	逐步完成任务状态
`blockDiagram`	显示史诗结构和任务计数的框图
`radarChart`	显示按状态划分的任务分布的条形图
`kanbanBoard`	看板式任务状态可视化
`sequenceDiagram`	显示随时间推移的任务交互的序列图
`classDiagram`	UML 风格的类图，展示史诗结构关系

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

🐳 Docker 部署

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

构建Docker镜像

# Build the Docker image
docker build -t intelliplan-mcp .

使用 Docker 运行

# Create a directory to persist data
mkdir -p .intelliplan-data

# Run the container with local volume mount
docker run -d \
  --name intelliplan-mcp \
  -v $(pwd)/.intelliplan-data:/data \
  -p 4007:4007 \
  intelliplan-mcp

存储配置选项

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

1.远程模式（默认）

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

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.本地模式

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

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：

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并运行：

docker-compose up -d

🔄 远程服务器模式

IntelliPlan 现已支持远程服务器模式，允许您将史诗和任务存储在中央服务器上，而不是直接存储在本地文件系统上。这有利于团队协作，并支持您从多个设备访问计划数据。

📡 设置远程服务器

启动 API 服务器：
# Set environment variables for configuration or use defaults npm run start:api
API 服务器的环境变量：
- PORT ：运行服务器的端口（默认值：3000）
- STORAGE_PATH ：API 服务器存储数据的位置（默认值：当前目录）

🔌 连接到远程服务器

简单配置：
至少，您只需要设置：
STORAGE_MODE=remote
默认情况下，这将连接到在http://localhost:4007上运行的服务器。
高级配置（可选）：
STORAGE_MODE=remote REMOTE_API_URL=http://your-server:4007 # Custom server URL REMOTE_API_KEY=your-api-key # If authentication is enabled
以远程模式启动 IntelliPlan ：
npm run dev
在 Cursor 中配置：添加到您的.cursor-settings.json ：
{ "mcpServers": { "IntelliPlanMCP": { "command": "node", "args": ["path/to/dist/index.js"], "env": { "STORAGE_MODE": "remote" } } } }

🛡️ 安全注意事项

API 服务器包含基本速率限制和 CORS 保护
对于生产用途，请考虑添加：
- HTTPS加密
- 强身份验证
- 更强大的输入验证
- 您的数据备份解决方案

📋 使用 listEpics 进行 Epic 管理

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

🔍 过滤和排序选项

listEpics工具支持以下参数：

范围	类型	默认	描述
`statusFilter`	细绳	'全部'	按状态过滤史诗（“全部”、“待办事项”、“进行中”、“完成”）
`sortBy`	细绳	“已更新”	按字段对史诗进行排序（“名称”、“创建”、“更新”、“状态”、“完成”）
`sortOrder`	细绳	‘描述’	排序顺序 ('asc', 'desc')
`limit`	数字	20	返回的最大史诗数量
`basePath`	细绳	-	存储的基本路径（如果尚未配置存储则需要）

📊 输出格式

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

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

🚀 使用示例

基本用法：

@IntelliPlanMCP listEpics

通过过滤和排序：

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

未配置存储时：

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

🛠️ 入门

安装 IntelliPlan ：
npm install npm run build
在 Cursor 中配置：添加到您的.cursor-settings.json ：
{ "mcpServers": { "IntelliPlanMCP": { "command": "node", "args": ["path/to/dist/index.js"], "env": { "STORAGE_MODE": "remote" } } } }
启用并开始规划：在您的编辑器设置中激活 MCP 并开始组织您的开发流程！

📝 定制规划流程

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

创建配置文件：您可以将 JSON 配置文件放置在项目中的任何位置。建议使用config/planning/目录进行组织，但这不是必需的。请参阅config/sample-planning-config.json获取示例。
使用配置生成器：IntelliPlan 提供了一个交互式工具来创建规划配置：
@IntelliPlanMCP createPlanningConfig currentStep=0
这将指导您逐步定义您的自定义规划步骤。
直接创建配置：对于更高级的用户，您可以直接创建配置：
@IntelliPlanMCP createDirectPlanningConfig name="Custom Plan" description="Your custom planning process" outputPath="config/your-config.json" steps=[...]
配置结构：
{ "id": "your-plan-id", "name": "Your Plan Name", "description": "Description of your planning process", "version": "1.0", "defaultMaxDepth": 3, "includeTestStrategy": true, "steps": [ { "id": "step-id", "name": "Step Name", "description": "Step description", "order": 0, "instructions": ["Instruction 1", "Instruction 2"], "thinkingPrompts": ["Thinking prompt 1", "Thinking prompt 2"], "nextStepPrompt": "Guidance for the next step", "requiresPreviousStepData": false } // Additional steps... ] }
使用自定义配置：
@IntelliPlanMCP planEpic description="Your project" configPath="full/path/to/your/config.json"
LLM 生成的配置：配置路径不必指向现有文件。语言模型可以根据您的需求动态生成自定义规划配置。只需让 LLM 根据您的特定需求创建规划配置，它就会根据您的用例生成合适的 JSON 配置。

🔍 为什么选择 IntelliPlan？

与传统的任务管理器（它们位于开发环境之外）不同，IntelliPlan 可在您编写代码时直接运行。这种集成消除了上下文切换，并使您的计划与实施紧密结合。

IntelliPlan 的 AI 功能超越了简单的任务跟踪——它了解项目的结构并为实施、测试策略和复杂性分析提供智能建议。

📄 许可证

麻省理工学院

IntelliPlan