mcp-shrimp-task-manager/README.md

English | 中文

MCP Shrimp Task Manager

🚀 An intelligent task management system based on Model Context Protocol (MCP), providing an efficient programming workflow framework for AI Agents.

Shrimp Task Manager guides Agents through structured workflows for systematic programming, enhancing task memory management mechanisms, and effectively avoiding redundant and repetitive coding work.

✨ Features

• Task Planning and Analysis: Deep understanding and analysis of complex task requirements
• Intelligent Task Decomposition: Automatically break down large tasks into manageable smaller tasks
• Dependency Management: Precisely handle dependencies between tasks, ensuring correct execution order
• Execution Status Tracking: Real-time monitoring of task execution progress and status
• Task Completeness Verification: Ensure task results meet expected requirements
• Task Complexity Assessment: Automatically evaluate task complexity and provide optimal handling suggestions
• Automatic Task Summary Updates: Automatically generate summaries upon task completion, optimizing memory performance
• Task Memory Function: Automatically backup task history, providing long-term memory and reference capabilities

🔄 Task Management Workflow

The system provides a complete task management lifecycle:

1. Start Planning plan_task: Analyze task problems, determine requirement scope
2. In-depth Analysis analyze_task: Check existing codebase to avoid duplicate work
3. Solution Reflection reflect_task: Critically review analysis results, ensure comprehensive solutions
4. Task Decomposition split_tasks: Break down complex tasks into smaller ones, establish clear dependencies
5. Task List list_tasks: View all tasks and their execution status
6. Execute Task execute_task: Execute specific tasks while assessing complexity
7. Result Verification verify_task: Comprehensively check task completion
8. Task Completion complete_task: Mark tasks as complete and generate reports, automatically update summaries
9. Task Management delete_task: Manage incomplete tasks (completed tasks remain in the system)
10. Query Tasks query_task: Search for related tasks in past memories using keywords
11. Display Task get_task_detail: Display complete task guidance

🧠 Task Memory Function

Shrimp Task Manager has long-term memory capabilities, automatically saving task execution history and providing reference experiences when planning new tasks.

Key Features

• The system automatically backs up tasks to the memory directory
• Backup files are named in chronological order, in the format tasks_backup_YYYY-MM-DDThh-mm-ss.json
• Task planning Agents automatically receive guidance on how to use the memory function

Advantages and Benefits

• Avoid Duplicate Work: Reference past tasks, no need to solve similar problems from scratch
• Learn from Successful Experiences: Utilize proven effective solutions, improve development efficiency
• Learning and Improvement: Identify past mistakes or inefficient solutions, continuously optimize workflows
• Knowledge Accumulation: Form a continuously expanding knowledge base as system usage increases

Through effective use of the task memory function, the system can continuously accumulate experience, with intelligence level and work efficiency continuously improving.

📚 Documentation Resources

• System Architecture: Detailed system design and data flow explanation

🔧 Installation and Usage

Installing via Smithery

To install Shrimp Task Manager for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @cjo4m06/mcp-shrimp-task-manager --client claude

Manual Installation

# Install dependencies
npm install

# Build and start service
npm run build

🔌 Using with MCP-Compatible Clients

Shrimp Task Manager can be used with any client that supports the Model Context Protocol, such as Cursor IDE.

Configuration in Cursor IDE

Shrimp Task Manager offers two configuration methods: global configuration and project-specific configuration.

Global Configuration

1. Open the Cursor IDE global configuration file (usually located at ~/.cursor/mcp.json)
2. Add the following configuration in the mcpServers section:

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/mcp-shrimp-task-manager/data"
      }
    }
  }
}

⚠️ Please replace /mcp-shrimp-task-manager with your actual path.

Project-Specific Configuration

You can also set up dedicated configurations for each project to use independent data directories for different projects:

1. Create a .cursor directory in the project root
2. Create an mcp.json file in this directory with the following content:

{
  "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
      }
    }
  }
}

⚠️ Important Configuration Notes

The DATA_DIR parameter is the directory where Shrimp Task Manager stores task data, conversation logs, and other information. Setting this parameter correctly is crucial for the normal operation of the system. This parameter must use an absolute path; using a relative path may cause the system to incorrectly locate the data directory, resulting in data loss or function failure.

Warning

: Using relative paths may cause the following issues:

• Data files not found, causing system initialization failure
• Task status loss or inability to save correctly
• Inconsistent application behavior across different environments
• System crashes or failure to start

💡 System Prompt Guidance

Cursor IDE Configuration

You can enable Cursor Settings => Features => Custom modes, and configure the following two modes:

TaskPlanner Mode

You are a professional task planning expert who must interact with users, analyze their requirements, and collect project-related information, ultimately using mcp_shrimp_task_manager_plan_task to establish tasks. When tasks are established, you must summarize and inform users to use the Task Execution Model for task execution. You must focus on task planning and are prohibited from using mcp_shrimp_task_manager_execute_task to execute tasks. Serious warning: you are a task planning expert, you cannot directly modify code, you can only plan tasks, and you cannot directly modify code, you can only plan tasks.

TaskExecutor Mode

You are a professional task execution expert. When users specify task execution, use mcp_shrimp_task_manager_execute_task for task execution. Without specified tasks, use mcp_shrimp_task_manager_list_tasks to find unexecuted tasks and execute them. After completion, you must summarize and inform users. You can only execute one task at a time, and unless explicitly instructed by users, you are prohibited from proceeding to the next task after a single task is completed. If users request "continuous mode," execute all tasks in sequence.

💡 Choose the appropriate mode based on your needs:

• Use TaskPlanner mode when planning tasks
• Use TaskExecutor mode when executing tasks

Using with Other Tools

If your tool doesn't support Custom modes, you can:

• Manually paste the appropriate prompts at different stages
• Or directly use simple commands like Please plan the following task: ...... or Please start executing the task...

🛠️ Available Tools Overview

After configuration, you can use the following tools:

Category	Tool Name	Description
Task Planning	plan_task	Start planning tasks
Task Analysis	analyze_task	In-depth analysis of task requirements
Solution Assessment	reflect_task	Reflect and improve solution concepts
Task Management	split_tasks	Break tasks into subtasks
	list_tasks	Display all tasks and status
	query_task	Search and list tasks
	get_task_detail	Display complete task details
	delete_task	Delete incomplete tasks
Task Execution	execute_task	Execute specific tasks
	verify_task	Verify task completion
	complete_task	Mark tasks as completed

🔧 Technical Implementation

• Node.js: High-performance JavaScript runtime environment
• TypeScript: Provides type-safe development environment
• MCP SDK: Interface for seamless interaction with large language models
• UUID: Generate unique and reliable task identifiers

📄 License

This project is released under the MIT License