Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 3.55 KB

File metadata and controls

115 lines (83 loc) · 3.55 KB

Developer Documentation

Technical documentation for Claude MPM contributors and extenders.

Documentation Structure

Core Documentation

Development Guides

Technical Deep Dives

  • Code Navigation - Detailed codebase navigation guides
  • Internals - Internal implementation details and mechanisms
  • Troubleshooting - Development troubleshooting guides
  • Testing - Testing framework, evaluation system, and QA processes

Quick Links

New to the codebase?

  1. Read Architecture → Understand system design
  2. Browse API Reference → Learn service interfaces
  3. Explore Extending → Build extensions

Common Tasks:

Development Setup:

# Clone and install
git clone https://github.com/bobmatnyc/claude-mpm.git
cd claude-mpm
pip install -e ".[dev,monitor]"

# Run tests
make test

# Run quality checks
make quality

# Fix linting issues
make lint-fix

Architecture Overview

Service-Oriented Design: Five specialized domains

  1. Core Services: Fundamental system operations
  2. Agent Services: Agent lifecycle and management
  3. Orchestration Services: Multi-agent coordination
  4. MCP Services: External tool integration
  5. Utility Services: Supporting functionality

Key Concepts:

  • Three-Tier Agent System: PROJECT > USER > SYSTEM hierarchy
  • Hook System: Event-driven pre/post execution hooks
  • Memory System: Persistent project-specific knowledge
  • Service Contracts: Clear interfaces between components

Contributing

Development Workflow:

  1. Fork and clone repository
  2. Create feature branch
  3. Make changes with tests
  4. Run quality checks: make quality
  5. Submit pull request

Code Standards:

  • Python 3.11+ compatibility
  • Type hints required
  • Docstrings for public APIs
  • Tests for new features
  • Linting with ruff
  • Formatting with black

Testing:

# Run all tests
make test

# Run specific test
pytest tests/test_specific.py

# Run with coverage
make test-coverage

Resources