英语|中文
目录
MCP Shrimp 任务管理器
🚀 基于模型上下文协议（MCP）的智能任务管理系统，为AI代理提供高效的编程工作流框架。
Shrimp Task Manager 通过结构化的工作流引导 Agent 进行系统化编程，增强任务内存管理机制，有效避免冗余重复的编码工作。
✨ 特点
- 任务规划与分析：深入理解和分析复杂的任务需求
- 智能任务分解：自动将大任务分解为可管理的小任务
- 依赖管理：精确处理任务之间的依赖关系，确保正确的执行顺序
- 执行状态追踪：实时监控任务执行进度及状态
- 任务完整性验证：确保任务结果满足预期要求
- 任务复杂度评估：自动评估任务复杂度并提供最优处理建议
- 自动任务摘要更新：任务完成后自动生成摘要，优化内存性能
- 任务记忆功能：自动备份任务历史记录，提供长期记忆和参考能力
- 研究模式：系统的技术研究能力，具有探索技术、最佳实践和解决方案比较的指导工作流程
- 项目规则初始化：定义项目标准和规则，以保持大型项目的一致性
- Web GUI ：提供可选的基于 Web 的图形用户界面，用于���务管理。通过在
.env文件中设置ENABLE_GUI=true来启用。启用后，将在DATA_DIR中创建一个包含访问地址的WebGUI.md文件。
🧭 使用指南
Shrimp Task Manager 通过引导式工作流程和系统化任务管理为 AI 辅助编程提供结构化方法。
什么是虾？
Shrimp 本质上是一个提示模板，用于引导 AI 代理更好地理解和处理您的项目。它使用一系列提示来确保代理与您项目的特定需求和惯例紧密契合。
研究模式实践
在深入任务规划之前，您可以利用研究模式进行技术调查和知识收集。这在以下情况下尤其有用：
- 你需要探索新技术或框架
- 您想比较不同的解决方案
- 您正在调查项目的最佳实践
- 你需要理解复杂的技术概念
只需告诉代理“研究[你的主题]”或“进入[技术/问题]研究模式”，即可开始系统性调查。研究结果将为你后续的任务规划和开发决策提供参考。
首次设置
在处理新项目时，只需告诉代理“初始化项目规则”。这将引导代理生成一套根据项目特定需求和结构定制的规则。
任务规划流程
要开发或更新功能，请使用命令“plan task [您的描述]”。系统将参考之前制定的规则，尝试了解您的项目，搜索相关的代码段，并根据项目的当前状态提出全面的计划。
反馈机制
在规划过程中，Shrimp 会引导 Agent 完成多个思考步骤。您可以回顾此流程，如果觉得方向不对，可以提出反馈。只需打断并分享您的观点，Agent 就会采纳您的反馈，并继续规划流程。
任务执行
当您对计划满意后，使用“执行任务 [任务名称或 ID]”来执行该计划。如果您未指定任务名称或 ID，系统将自动识别并执行优先级最高的任务。
连续模式
如果您希望按顺序执行所有任务而不手动干预每个任务，请使用“连续模式”自动处理整个任务队列。
代币限制说明
由于 LLM 令牌限制，长时间对话中可能会丢失上下文。如果发生这种情况，只需打开新的聊天会话并请求代理继续执行即可。系统将从中断处继续执行，无需您重复任务详细信息或上下文。
提示语言和定制
您可以通过设置TEMPLATES_USE环境变量来切换系统提示语言。它默认支持en （英语）和zh （繁体中文）。此外，您还可以将现有模板目录（例如src/prompts/templates_en ）复制到DATA_DIR指定的位置，进行修改，然后将TEMPLATES_USE指向您的自定义模板目录名称。这允许更深入地自定义提示。有关详细说明，请参阅。
🔬 研究模式
Shrimp Task Manager 包含一个专门的研究模式，旨在进行系统的技术调查和知识收集。
什么是研究模式？
研究模式是一个引导式工作流系统，可帮助 AI 代理进行全面而系统的技术研究。它提供了结构化的方法来探索技术、比较解决方案、研究最佳实践以及收集编程任务所需的全面信息。
主要特点
- 系统调查：结构化的工作流程确保全面覆盖研究主题
- 多源研究：结合网络搜索和代码库分析，以获得全面理解
- 状态管理：维护多个会话中的研究背景和进度
- 引导式探索：防止研究失去重点或偏离主题
- 知识整合：将研究成果与任务规划和执行无缝集成
何时使用研究模式
研究模式对于以下方面尤其有价值：
- 技术探索：研究新的框架、库或工具
- 最佳实践研究：寻找行业标准和推荐方法
- 解决方案比较：评估不同的技术方法或架构
- 问题调查：深入探究复杂的技术挑战
- 架构规划：研究设计模式和系统架构
如何使用研究模式
只需告诉代理进入您的主题的研究模式：
- 基本用法：“进入[你的主题]研究模式”
- 具体研究：“研究[具体技术/问题]”
- 比较分析：“研究并比较[选项 A 与 B]”
该系统将指导代理完成结构化的研究阶段，确保彻底调查，同时关注您的特定需求。
研究工作流程
- 主题定义：明确研究范围和目标
- 信息收集：系统地收集相关信息
- 分析与综合：处理和组织研究结果
- 状态更新：定期进度跟踪和上下文保存
- 整合：将研究成果应用到你的项目环境中
💡 建议：为了获得最佳研究模式体验，我们建议使用Claude 4 Sonnet ，它提供卓越的分析能力和全面的研究综合。
🧠 任务记忆功能
Shrimp Task Manager 具有长期记忆功能，自动保存任务执行历史，为规划新任务时提供参考经验。
主要特点
- 系统自动备份任务到内存目录
- 备份文件按时间顺序命名，格式为tasks_backup_YYYY-MM-DDThh-mm-ss.json
- 任务规划代理自动接收如何使用记忆功能的指导
优势和好处
- 避免重复工作：参考过去的任务，无需从头开始解决类似的问题
- 学习成功经验：利用经过验证的有效解决方案，提高开发效率
- 学习与改进：找出过去的错误或低效的解决方案，不断优化工作流程
- 知识积累：随着系统使用量的增加，形成不断扩大的知识库
通过有效利用任务记忆功能，系统可以不断积累经验，智能水平和工作效率不断提高。
📋 项目规则初始化
项目规则功能有助于维护整个代码库的一致性：
- 标准化开发：建立一致的编码模式和实践
- 加入新开发人员：为项目贡献提供明确的指导
- 保持质量：确保所有代码符合既定的项目标准
⚠️ 建议：当项目规模扩大或发生重大变更时，初始化项目规则。这有助于在项目复杂性增加的情况下保持一致性和质量。
在以下情况下，使用init_project_rules工具来设置或更新项目标准：
- 启动一个新的大型项目
- 招募新团队成员
- 实施重大架构变革
- 采用新的开发惯例
使用示例
您可以使用简单的自然语言命令轻松访问此功能：
- 对于初始设置：只需告诉代理“初始化规则”或“初始化项目规则”
- 对于更新：当您的项目进展时，告诉代理“更新规则”或“更新项目规则”
当您的代码库扩展或经历重大结构变化时，此工具特别有价值，有助于在整个项目生命周期内保持一致的开发实践。
📚 文档资源
🔧 安装和使用
通过 Smithery 安装
要通过Smithery自动为 Claude Desktop 安装 Shrimp Task Manager：
npx -y @smithery/cli install @cjo4m06/mcp-shrimp-task-manager --client claude
手动安装
# Install dependencies
npm install
# Build and start service
npm run build
🔌 与 MCP 兼容的客户端一起使用
Shrimp Task Manager 可以与任何支持模型上下文协议的客户端一起使用，例如 Cursor IDE。
Cursor IDE 中的配置
Shrimp Task Manager 提供两种配置方式：全局配置和项目特定配置。
全局配置
- 打开 Cursor IDE 全局配置文件（通常位于
~/.cursor/mcp.json ） - 在
mcpServers部分添加以下配置：
{
"mcpServers": {
"shrimp-task-manager": {
"command": "node",
"args": ["/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
or
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/mcp-shrimp-task-manager/data",
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
⚠️ 请将/mcp-shrimp-task-manager替换为你的实际路径。
项目特定配置
您还可以为每个项目设置专用配置，以便为不同的项目使用独立的数据目录：
- 在项目根目录中创建
.cursor目录 - 在此目录中创建一个
mcp.json文件，其内容如下：
{
"mcpServers": {
"shrimp-task-manager": {
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": "/path/to/project/data", // Must use absolute path
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
or
{
"mcpServers": {
"shrimp-task-manager": {
"command": "npx",
"args": ["-y", "mcp-shrimp-task-manager"],
"env": {
"DATA_DIR": "/path/to/project/data", // Must use absolute path
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
⚠️ 重要配置说明
DATA_DIR 参数是 Shrimp Task Manager 存储任务数据、对话日志等信息的目录。正确设置此参数对于系统的正常运行至关重要。此参数必须使用绝对路径；使用相对路径可能会导致系统错误地定位数据目录，从而导致数据丢失或功能失败。
警告：使用相对路径可能会导致以下问题：
- 找不到数据文件，导致系统初始化失败
- 任务状态丢失或无法正确保存
- 不同环境中的应用程序行为不一致
- 系统崩溃或无法启动
🔧 环境变量配置
Shrimp Task Manager 支持通过环境变量自定义提示行为，让您无需修改代码即可微调 AI 助手的响应。您可以在配置中或通过.env文件设置这些变量：
{
"mcpServers": {
"shrimp-task-manager": {
"command": "node",
"args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
"env": {
"DATA_DIR": "/path/to/project/data",
"MCP_PROMPT_PLAN_TASK": "Custom planning guidance...",
"MCP_PROMPT_EXECUTE_TASK_APPEND": "Additional execution instructions...",
"TEMPLATES_USE": "en",
"ENABLE_GUI": "false"
}
}
}
}
定制方法有两种：
- 覆盖模式（
MCP_PROMPT_[FUNCTION_NAME] ）：完全替换默认提示 - 附加模式（
MCP_PROMPT_[FUNCTION_NAME]_APPEND ）：将内容添加到现有提示
此外，还有其他系统配置变量：
- DATA_DIR ：指定存储任务数据的目录
- TEMPLATES_USE ：指定提示使用的模板集。默认为
en 。当前可用选项为en和zh 。要使用自定义模板，请将src/prompts/templates_en目录复制到DATA_DIR指定的位置，重命名复制的目录（例如，重命名为my_templates ），并将TEMPLATES_USE设置为新的目录名称（例如， my_templates ）。
有关自定义提示的详细说明（包括支持的参数和示例），请参阅提示自定义指南。
💡系统提示引导
游标 IDE 配置
您可以启用“光标设置”=>“功能”=>“自定义模式”，并配置以下两种模式：
TaskPlanner模式
You are a professional task planning expert. You must interact with users, analyze their needs, and collect project-related information. Finally, you must use "plan_task" to create tasks. When the task is created, you must summarize it and inform the user to use the "TaskExecutor" mode to execute the task.
You must focus on task planning. Do not use "execute_task" to execute tasks.
Serious warning: you are a task planning expert, you cannot modify the program code directly, you can only plan tasks, and you cannot modify the program code directly, you can only plan tasks.
TaskExecutor模式
You are a professional task execution expert. When a user specifies a task to execute, use "execute_task" to execute the task.
If no task is specified, use "list_tasks" to find unexecuted tasks and execute them.
When the execution is completed, a summary must be given to inform the user of the conclusion.
You can only perform one task at a time, and when a task is completed, you are prohibited from performing the next task unless the user explicitly tells you to.
If the user requests "continuous mode", all tasks will be executed in sequence.
💡根据您的需求选择合适的模式：
- 计划任务时使用TaskPlanner模式
- 执行任务时使用TaskExecutor模式
与其他工具一起使用
如果您的工具不支持自定义模式，您可以：
- 在不同阶段手动粘贴适当的提示
- 或者直接使用简单的命令，如
Please plan the following task: ......或Please start executing the task...
🛠️ 可用工具概览
配置完成后，您可以使用以下工具：
| 类别 | 工具名称 | 描述 |
|---|
| 任务规划 | plan_task | 开始规划任务 |
| 任务分析 | analyze_task | 深入分析任务需求 |
| process_thought | 复杂问题的逐步推理 |
| 解决方案评估 | reflect_task | 反思并改进解决方案概念 |
| 研究与调查 | research_mode | 进入系统化技术研究模式 |
| 项目管理 | init_project_rules | 初始化或更新项目标准和规则 |
| 任务管理 | split_tasks | 将任务分解为子任务 |
| list_tasks | 显示所有任务和状态 |
| query_task | 搜索和列出任务 |
| get_task_detail | 显示完整的任务详细信息 |
| delete_task | 删除未完成的任务 |
| 任务执行 | execute_task | 执行特定任务 |
| verify_task | 验证任务完成情况 |
🔧 技术实现
- Node.js ：高性能 JavaScript 运行时环境
- TypeScript ：提供类型安全的开发环境
- MCP SDK ：与大型语言模型无缝交互的接口
- UUID ：生成唯一且可靠的任务标识符
📄 许可证
该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅LICENSE文件。
推荐型号
为了获得最佳体验，我们建议使用以下模型：
- Claude 3.7 ：提供强大的理解和生成能力。
- Gemini 2.5 ：谷歌最新型号，性能出色。
由于不同模型的训练方法和理解能力存在差异，使用其他模型对相同问题进行处理可能会导致结果不同。本项目已针对 Claude 3.7 和 Gemini 2.5 进行了优化。
星史