🚀 MCP Shrimp Task Manager
MCP Shrimp Task Manager is a task planning and execution tool based on large language models (LLMs). It offers a series of powerful commands and configuration options to help users efficiently manage and execute various tasks.
🚀 Quick Start
MCP Shrimp Task Manager is a task planning and execution tool powered by large language models (LLMs). It equips users with a suite of potent commands and configuration options, facilitating the efficient management and execution of diverse tasks.
✨ Features
Core Features
Task Planning
MCP Shrimp Task Manager offers robust task planning capabilities:
plan_task
: Initiate the planning of a new task.
analyze_task
: Conduct an in - depth analysis of task requirements.
process_thought
: Perform step - by - step reasoning when dealing with complex problems.
Task Execution
Once a task is planned, you can use the following commands to execute it:
execute_task
: Execute a specific task.
verify_task
: Verify the completion status of a task.
complete_task
: Mark a task as completed.
Other Features
Project Management
init_project_rules
: Initialize or update project standards and rules.
split_tasks
: Decompose a task into subtasks.
Task Query and Maintenance
list_tasks
: List all tasks and their statuses.
query_task
: Search for and list tasks.
get_task_detail
: Display detailed information about a task.
delete_task
: Delete an incomplete task.
📦 Installation
Install Dependencies
Before using MCP Shrimp Task Manager, ensure you have installed the following dependencies:
- Node.js: Version 18.0.0 or higher is required.
- npm: The default package management tool for Node.js, used to install other necessary libraries.
Clone the Repository
You can clone the MCP Shrimp Task Manager repository from GitHub:
git clone https://github.com/cjo4m06/mcp-shrimp-task-manager.git
Install Dependencies
After entering the project directory, run the following command to install all necessary dependencies:
npm install
📚 Documentation
Configuration Instructions
The configuration files of MCP Shrimp Task Manager are located in the config
directory of the project. The main configuration options are as follows:
- API Key: If you plan to use external API services (such as Claude or Gemini), enter your API key here.
- Model Selection: Supports multiple large language models, including Claude, Gemini, etc. Choose the appropriate model according to your needs.
- Task Management: Configure the task storage location, default task templates, etc.
Custom Configuration
MCP Shrimp Task Manager allows users to customize its behavior through the configuration file. The main configuration options include:
- Model Selection: Supports multiple large language models such as Claude, Gemini, etc.
- API Settings: Configure the API key and endpoint for calling the large language model.
- Task Storage: Set the persistent storage location for task data.
Tutorials and Guides
Using Custom Modes
You can enable custom modes in the Cursor IDE and choose one of the following two modes as needed:
Task Planning Mode
You are a professional task planning expert. You need to interact with users, analyze their needs, and collect project - related information. Finally, use "plan_task" to create a task. After the task is created, you must summarize it and notify the user to use the "TaskExecutor" mode to execute the task.
You must focus on task planning. You cannot directly modify the code; you can only achieve the goal through planned tasks.
Severe warning: You are a task planning expert and cannot directly modify the code; you can only perform task planning.
Task Execution Mode
You are a professional task execution expert. When the user specifies a task to execute, use the "execute_task" command to execute it.
If no specific task is specified, list all incomplete tasks and select one to execute.
After the task is completed, you must provide a summary to notify the user of the result.
You can only execute one task at a time and cannot automatically execute the next task without the user's explicit instruction. If the user requests "continuous mode", all tasks will be executed sequentially.
Using Other Tools
If your tool does not support custom modes, you can:
- Manually paste the appropriate prompt for the current stage.
- Or directly use simple commands such as
Please start planning the following task: ...
or Please start executing the task...
💻 Usage Examples
Example 1: Create a New Task
cd mcp-shrimp-task-manager
node src/commands plan_task "Implement a user authentication system"
Example 2: Execute a Task
node src/commands list_tasks
node src/commands execute_task <task_id>
🔧 Technical Details
MCP Shrimp Task Manager is built on the following technologies:
- Node.js: A high - performance JavaScript runtime environment.
- npm: The default package management tool for Node.js, used to install other dependent libraries.
📄 License
This project is licensed under the MIT License. The specific content is as follows:
MIT License
Copyright (c) 年份 作者名
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Project Contributors
Core Development Team
- @cjo4m06: Project initiator and main developer.
Contributors
- [Your Name]: Add a description of your contribution to the project.
Project Links
Thank you for your attention and support for MCP Shrimp Task Manager! We hope our tool will bring convenience to your work.