README.md

Shrimp Task Manager Documentation

Complete guide for using MCP Shrimp Task Manager - an intelligent task management system for AI-powered development.

📚 Documentation

Getting Started

• Quick Start Guide - Get up and running quickly
• Installation Guide - Detailed setup instructions
• Configuration - Environment and settings

Core Concepts

• What is Shrimp? - Understanding the system
• Task Management - How tasks work
• Workflows - Structured development processes

Features

• Available Tools - Complete tool reference
• Agent Management - AI agent specialization
• Research Mode - Systematic exploration
• Project Rules - Standards and conventions

User Interfaces

• Task Viewer - React-based visual interface
• Web GUI - Lightweight web interface

Developer Resources

• API Reference - Complete API documentation
• Prompt Customization - Customize AI prompts
• SDK Usage - Integrate with your code

Advanced Topics

• Token Optimization - Managing context limits
• Memory Management - Task persistence
• Best Practices - Tips and guidelines

🌐 Internationalization

Documentation is available in multiple languages:

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

📖 How to Use This Documentation

For New Users

1. Start with the Quick Start Guide
2. Read What is Shrimp? to understand the system
3. Follow the Installation Guide for detailed setup
4. Try the example workflows in Common Use Cases

For Developers

1. Review the API Reference
2. Explore Available Tools
3. Learn about Agent Management
4. Check Best Practices

For Advanced Users

1. Master Token Optimization
2. Customize with Prompt Customization
3. Implement Project Rules
4. Explore Research Mode

🔍 Quick Reference

Essential Commands

Command	Purpose
init project rules	Set up project standards
plan task [description]	Create task plan
execute task	Run next task
continuous mode	Auto-execute all tasks
list tasks	View task queue
research [topic]	Explore technologies

Key Concepts

• Task: A unit of work with clear objectives
• Agent: Specialized AI configuration for specific roles
• Rules: Project-specific standards and conventions
• Memory: Persistent task history across sessions
• Research: Systematic exploration mode

🤝 Contributing to Documentation

We welcome documentation improvements! Please:

1. Follow the existing structure
2. Include examples where possible
3. Keep language clear and concise
4. Update all language versions if possible
5. Submit via GitHub Pull Request

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Updates: Release Notes

---

Documentation Version: 3.0.0
Last Updated: January 2025