PMAT Documentation

Welcome to the PMAT (Pragmatic AI MCP Agent Toolkit) documentation.

📚 Documentation Structure

Core Documentation

• SPECIFICATION.md - Complete system specification (source of truth)
• CLAUDE_CODE_AGENT.md - Claude Code Agent Mode user guide (v2.12.0)
• DISTRIBUTION_STATUS.md - Multi-ecosystem distribution status and automation
• DOCUMENTATION_STRUCTURE.md - Documentation organization guide

Active Documentation

Architecture & Design

• architecture/ - System architecture and design decisions
  • ARCHITECTURE.md - High-level architecture overview
  • decisions/ - Architecture Decision Records (ADRs)

Development

• execution/ - Sprint planning and execution
  • roadmap.md - Development roadmap with task tracking
  • quality-gates.md - Quality enforcement standards
  • velocity.json - Sprint velocity metrics

Features

• features/ - Feature documentation
  • README.md - Feature overview
  • Individual feature guides for each major capability

User Guides

• guides/ - User and integration guides
  • interfaces-overview.md - CLI, MCP, HTTP interfaces
  • refactor-auto-guide.md - Automated refactoring guide
  • github-actions-quality-gate.md - CI/CD integration

Operations

• operations/ - Operational documentation
  • configuration.md - Configuration guide
  • error-handling.md - Error handling patterns
  • telemetry.md - Monitoring and telemetry

Quality & Testing

• quality/ - Quality standards and metrics
  • standards.md - Code quality standards
• testing/ - Testing documentation
  • property-based.md - Property-based testing guide
  • integration.md - Integration testing
  • performance.md - Performance testing

Specifications

• specifications/ - Feature specifications
  • roadmap-todo-quality-gate-spec.md - Roadmap management spec

Release Information

• release-process.md - Release workflow and procedures
• release_notes/ - Recent release notes (v2.x+)
• /CHANGELOG.md - Complete version history

Development Planning

• todo/ - Future development specifications
  • Active specifications for upcoming features
  • archive/ - Completed or deprecated specs

Reference

• cli-reference.md - CLI command reference
• bugs/ - Known issues and bug reports
  • archived/ - Resolved issues

🗄️ Archived Documentation

Historical and deprecated documentation has been moved to the archive:

• archive/ - Archived documentation
  • ARCHIVE_INDEX.md - Archive navigation guide
  • pre-v2.0/ - Pre-2.0 version documentation
  • Historical release notes, implementation docs, and deprecated features

🚀 Quick Start

1. New Users: Start with SPECIFICATION.md for system overview
2. Developers: Check execution/roadmap.md for current tasks
3. Contributors: Review quality/standards.md for quality requirements
4. Integrators: See guides/interfaces-overview.md for API details

📖 Documentation Standards

All documentation follows these principles:

• Single Source of Truth: SPECIFICATION.md is the authoritative reference
• Version Synchronized: Documentation updates required with code changes
• Quality Enforced: Pre-commit hooks ensure documentation quality
• Toyota Way Aligned: Continuous improvement (Kaizen) approach

🔗 External Resources

• Repository: github.com/paiml/paiml-mcp-agent-toolkit
• Crates.io: crates.io/crates/pmat
• Homepage: paiml.com

Last Updated: 2025-01-21 | Version: 2.94.0