docs

Documentation Index

Complete documentation for the Mimir MCP Server - TODO Tracker, External Memory, and Knowledge Graph system.

🚀 Quick Start

New to Mimir? Start here:

• QUICKSTART.md - START HERE: 5-minute setup guide
• IDE_INTEGRATION_GUIDE.md - ⭐ Connect Mimir to VS Code, Cursor, Windsurf
• QUICK_REFERENCE.md - Quick command reference
• ECKO_QUICKSTART.md - Ecko prompt architect quick start
• MEMORY_GUIDE.md - External memory system for AI agents
• ORCHESTRATOR_QUICKSTART.md - Multi-agent orchestration quick start
• DOCKER_DEPLOYMENT_GUIDE.md - Deploy with Docker

📖 User Guides

Comprehensive guides for using Mimir:

Core Features

• MEMORY_GUIDE.md - External memory system for AI agents
• KNOWLEDGE_GRAPH.md - Associative memory networks and graph operations

Docker & Deployment

• DOCKER_DEPLOYMENT_GUIDE.md - Complete Docker deployment guide
• DOCKER_OLLAMA_SETUP.md - Running Mimir with containerized Ollama
• DOCKER_PATH_MAPPING.md - Understanding container path mappings
• DOCKER_RESOURCES.md - Docker resource configuration for Ollama

Orchestration

• ORCHESTRATOR_QUICKSTART.md - Multi-agent orchestration quick start
• ORCHESTRATOR_README.md - Detailed orchestration documentation

File Management

• FILE_BROWSER_GUIDE.md - File browser integration and usage

IDE Integration

• IDE_INTEGRATION_GUIDE.md - ⭐ Complete guide for VS Code, Cursor, Windsurf setup

🔗 Integration

Connecting Mimir with external platforms:

• OPENWEBUI_INTEGRATION.md - Open WebUI integration guide

⚙️ Configuration

Setup and configuration for different environments:

• CONFIGURATION.md - Environment variables, VSCode, Cursor, Claude Desktop setup

🏗️ Multi-Agent Architecture

Technical architecture for multi-agent systems:

• MULTI_AGENT_EXECUTIVE_SUMMARY.md - High-level strategic overview
• MULTI_AGENT_GRAPH_RAG.md - PM/Worker/QC agent pattern (technical deep dive)
• MULTI_AGENT_ROADMAP.md - ⭐ Implementation roadmap with deployment & enterprise features
• NAMING.md - Why "Mimir"? Norse mythology connections
• HISTORICAL_TRACKING_SYSTEM.md - Task execution history and analysis
• CONVERSATION_ANALYSIS.md - Architecture validation against research
• GRAPH_RAG_RESEARCH.md - Research backing and Graph-RAG methodology
• ANALYSIS_MCP_MEMORY.md - Memory system patterns and analysis
• MEMORY_VS_KG.md - TODO vs Knowledge Graph comparison

🚀 Future Roadmap Highlights:

• Phase 4 (Q1 2026): Remote centralized server deployment, multi-tenancy, Docker/Kubernetes
• Phase 5 (Q2 2026): Enterprise audit trail, compliance reporting, agent monitoring

🧪 Testing & Validation

Test suite documentation and results:

• TESTING_GUIDE.md - Test suite overview and guidelines
• MEMORY_PERSISTENCE_TEST_SUMMARY.md - 30 passing tests for persistence

🤖 Agent Configurations

Pre-configured agent settings:

• claudette-pm.md - Project Manager agent (task breakdown and coordination)
• claudette-todo.md - Full Claudette agent configuration with MCP integration
• claudette-auto.md - Autonomous execution mode for Claudette
• claudette-ecko.md - Knowledge graph specialist agent

Archived Agent Versions

See agents/archive/ for deprecated agent configurations.

📊 Results & Analysis

Performance benchmarks and execution results:

• report-4.1-success.md - Successful multi-agent execution report (v4.1)
• See ../benchmarks/ for detailed performance benchmarks

🔬 Research

Research documentation and comparisons:

See research/ for research papers, comparisons, and technical analysis.

📦 Archive

Historical documentation and implemented features:

• archive/implemented/ - Documentation for completed features
• archive/test-outputs/ - Historical test execution outputs
• archive/phase-implementations/ - Previous implementation phases

---

Back to: Main README | Agent Instructions