UNPKG

@cabbages-pre/memory-pickle-mcp-pre

Version:

Simplified MCP server for AI agent project management - 8 essential tools for session memory and task tracking

233 lines (173 loc) • 5.57 kB
# Usage Guide ## Getting Started Once installed, Memory Pickle works automatically. The agent will: 1. Load your project status when you start chatting 2. Create tasks when you mention work items 3. Track progress as you update 4. Generate summaries for handoffs ## Basic Workflow ### Starting a New Project Just mention what you're building: ``` You: "I'm creating a blog website with Next.js" Agent: I'll track this project for you. ``` The agent automatically: - Creates a project - Sets it as current - May suggest initial tasks ### Working on Tasks Mention what you need to do: ``` You: "I need to set up the database and create the post model" Agent: I've added those tasks: [DONE] Set up database [TODO] Create post model ``` ### Updating Progress Just say what you've completed: ``` You: "I finished setting up the database" Agent: Great! Marking that as complete. [DONE] Set up database - Complete! Project is now 33% complete. ``` ### Continuing Work Start any new session normally: ``` You: "Let's continue working" Agent: [Automatically loads project] ## Blog Website - 33% complete [DONE] Set up database [ ] Create post model [ ] Add authentication ``` ## Advanced Features ### Subtasks Break down complex work: ``` You: "The authentication needs login, signup, and password reset" Agent: I'll create subtasks for authentication: - [ ] Authentication - [ ] Login functionality - [ ] Signup functionality - [ ] Password reset ``` ### Priority Management Mention urgency: ``` You: "The login is critical - users can't access anything without it" Agent: Setting login as critical priority. [CRITICAL] Login functionality ``` ### Progress Tracking Update progress naturally: ``` You: "Login is about 80% done, just need to add error handling" Agent: Updated login progress to 80%. ## Login functionality - 80% complete Note: Need to add error handling ``` ### Blockers Mention what's blocking you: ``` You: "Can't deploy until we get the SSL certificate" Agent: I'll mark deployment as blocked. [BLOCKED] Deploy to production Blocked: Waiting for SSL certificate ``` *Note: Progress updates and blocker tracking are handled by the consolidated `update_task` tool.* ### Session Handoffs End sessions with summaries: ``` You: "I need to stop for today, can you summarize?" Agent: Here's your handoff summary: šŸ¤ Session Summary Completed: Database setup, user model In Progress: Login functionality (80%) Next: Finish login error handling, start signup Blockers: SSL certificate for deployment Copy this to continue in your next session. ``` ## Multiple Projects ### Switching Projects ``` You: "Let's work on my mobile app instead" Agent: Switching to mobile app project. šŸ“± Mobile App - 45% complete ``` ### Creating New Projects ``` You: "I want to start a new API project" Agent: Created new project: API Project All new tasks will be added here. ``` ## Memory System ### Storing Important Information The agent automatically remembers important decisions: ``` You: "We decided to use PostgreSQL instead of MongoDB for better consistency" Agent: I'll remember that decision. [STORED] Database choice - PostgreSQL for consistency ``` ### Recalling Information ``` You: "What did we decide about the database?" Agent: Found this memory: [MEMORY] Database choice - PostgreSQL for consistency Stored: 2 days ago ``` ## Data Organization **Memory-Only Storage:** - All data exists only in memory during the current session - No files or directories are created on disk - Data is automatically cleared when the session ends - For permanent storage, use `generate_handoff_summary` and save as markdown files ## Tips for Best Results 1. **Be natural** - Just talk about your work normally 2. **Mention priorities** - Say if something is urgent or critical 3. **Update progress** - Tell the agent what you've completed 4. **Use handoffs** - Get summaries before ending sessions 5. **Break down work** - Mention subtasks for complex features 6. **Note blockers** - Say what's preventing progress ## Common Patterns ### Daily Standup Style ``` You: "Yesterday I finished the user auth, today I'm working on the dashboard" Agent: [DONE] User auth - Completed! [ADDED] Dashboard implementation ``` ### Planning Session ``` You: "For the dashboard, I need charts, user stats, and settings" Agent: Breaking down dashboard: - [ ] Dashboard - [ ] Charts component - [ ] User statistics - [ ] Settings panel ``` ### Problem Solving ``` You: "The API is returning 500 errors, I think it's the database connection" Agent: [ERROR] API issues - 500 errors Blocker: Database connection problems ``` The key is to work naturally - Memory Pickle adapts to how you already talk about your projects. ## Configuration Options ### Clean Text Output Memory Pickle uses professional clean text output: **Output Format:** ``` [OK] Task completed successfully! ## Project Status: My App (75% complete) [ ] Build authentication system [high] [DONE] Set up database [medium] ## Blocked: SSL certificate needed ``` **Benefits:** - Professional appearance for all environments - Universal compatibility (terminal, SSH, etc.) - Better accessibility and screen reader support - Cleaner logs and automation output - No font or encoding dependencies - Consistent across all platforms and clients