MCP Shrimp Task Manager

🇺🇸 English | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇷 Français | 🇮🇹 Italiano | 🇮🇳 हिन्दी | 🇰🇷 한국어 | 🇧🇷 Português | 🇷🇺 Русский | 🇨🇳 中文

MCP Shrimp Task Manager

🦐 面向 AI 驱动开发的智能任务管理 - 将复杂项目拆解为易于管理的任务，跨会话保留上下文，并加速开发工作流。

🚀 快速开始

前提条件

• Node.js 18+
• npm 或 yarn
• 兼容 MCP 的 AI 客户端（Claude Code 等）

安装

安装 Claude Code

Windows 11（使用 WSL2）：

# First, ensure WSL2 is installed (in PowerShell as Administrator)
wsl --install

# Enter Ubuntu/WSL environment
wsl -d Ubuntu

# Install Claude Code globally
npm install -g @anthropic-ai/claude-code

# Start Claude Code
claude

macOS/Linux：

# Install Claude Code globally
npm install -g @anthropic-ai/claude-code

# Start Claude Code
claude

安装 Shrimp Task Manager

# Clone the repository
git clone https://github.com/cjo4m06/mcp-shrimp-task-manager.git
cd mcp-shrimp-task-manager

# Install dependencies
npm install

# Build the project
npm run build

配置 Claude Code

在项目目录中创建 .mcp.json 文件：

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/path/to/your/shrimp_data",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

配置示例：

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/home/fire/claude/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/home/fire/claude/project/shrimp_data",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

然后使用自定义 MCP 配置启动 Claude Code：

claude --dangerously-skip-permissions --mcp-config .mcp.json

开始使用

1. 初始化项目："init project rules"
2. 规划任务："plan task: implement user authentication"
3. 执行任务："execute task" 或 "continuous mode"

💡 Shrimp 是什么？

Shrimp Task Manager 是一个 MCP（模型上下文协议）服务，可改变 AI Agent 进行软件开发的方式。Shrimp 不会让上下文丢失或让工作重复，而是提供：

• 🧠 持久记忆：任务和进度会跨会话保留
• 📋 结构化工作流：为规划、执行和验证提供引导流程
• 🔄 智能拆解：自动将复杂任务拆解为易于管理的子任务
• 🎯 上下文保留：即使遇到令牌限制，也不会丢失进度

✨ 核心功能

任务管理

• 智能规划：在实施前深入分析需求
• 任务拆解：将大型项目拆解为原子化、可测试的单元
• 依赖关系跟踪：自动管理任务间的关系
• 进度监控：实时跟踪状态并更新

高级功能

• 🔬 研究模式：系统地探索技术和解决方案
• 🤖 Agent 系统：为特定任务分配专用 AI Agent（了解更多）
• 📏 项目规则：定义并维护整个项目的编码标准
• 💾 任务记忆：自动备份和恢复任务历史记录

Web 界面

🖥️ 任务查看器

现代化的 React 界面，支持通过拖放进行可视化任务管理、实时搜索和多配置文件。

快速设置：

cd tools/task-viewer
npm install
npm run start:all
# Access at http://localhost:5173

📖 任务查看器完整文档

🌐 Web GUI

可选的轻量级 Web 界面，用于快速查看任务概览。

在 .env 中启用：ENABLE_GUI=true

📚 文档

• 📖 完整文档
• 🛠️ 可用工具
• 🤖 Agent 管理
• 🎨 提示词自定义
• 🔧 API 参考

🎯 常见使用场景

Agent: "plan task: add user authentication with JWT"
# Agent analyzes codebase, creates subtasks

Agent: "execute task"
# Implements authentication step by step

Agent: "plan task: fix memory leak in data processing"
# Agent researches issue, creates fix plan

Agent: "continuous mode"
# Executes all fix tasks automatically

Agent: "research: compare React vs Vue for this project"
# Systematic analysis with pros/cons

Agent: "plan task: migrate component to chosen framework"
# Creates migration plan based on research

🛠️ 配置

环境变量

创建一个 .env 文件：

# Required
DATA_DIR=/path/to/data/storage

# Optional
ENABLE_GUI=true          # Enable web GUI
WEB_PORT=3000           # Custom web port
PROMPT_LANGUAGE=en      # Prompt language (en, zh, etc.)

可用命令

🤝 参与贡献

欢迎贡献！详情请参阅我们的贡献指南。

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

🌟 致谢

由 cjo4m06 创建，并由社区维护。

GitHub • 问题反馈 • 讨论