Skip to main content

Model Context Protocol (MCP) server for MAID Runner - exposes validation tools to AI agents via MCP

Project description

MAID Runner MCP

Model Context Protocol server for MAID Runner validation tools.

MAID Runner MCP exposes MAID Runner validation capabilities via the Model Context Protocol (MCP), enabling seamless integration with AI development tools like Claude Code, Aider, and custom AI agents.

What Is This?

MAID Runner MCP is a bridge between AI agents and MAID Runner's validation framework. It provides:

  • MCP Tools: Programmatic access to maid validate, maid snapshot, maid test, and other commands
  • MCP Resources: Access to manifests, schemas, validation results, and system architecture
  • MCP Prompts: Workflow guidance for AI agents through MAID methodology phases

Think of it as an API layer that lets AI agents interact with MAID Runner using standardized MCP protocol instead of subprocess calls.

Status

🚧 Alpha Release - Under active development.

This is part of the MAID ecosystem and follows the MAID methodology itself (self-dogfooding).

Quick Start

Installation

# Install from PyPI
pip install maid-runner-mcp

# Or with uv
uv pip install maid-runner-mcp

Running the Server

# Start MCP server (stdio transport)
maid-runner-mcp

# Or with uv
uv run maid-runner-mcp

Integration with Claude Code

Add to your .claude/mcp.json:

{
  "mcpServers": {
    "maid-runner": {
      "command": "uv",
      "args": ["run", "maid-runner-mcp"],
      "env": {
        "MAID_MANIFEST_DIR": "manifests"
      }
    }
  }
}

Now Claude Code can:

  • Validate manifests via maid_validate tool
  • Generate snapshots via maid_snapshot tool
  • Access manifest content via manifest:// resources
  • Get workflow guidance via prompts

Architecture

AI Agents (Claude, GPT-4, etc.)
        ↓
   MCP Protocol (JSON-RPC)
        ↓
  maid-runner-mcp (MCP Server)
        ↓
   MAID Runner (Validation Core)

Features

Tools (Actions with Side Effects)

  • maid_validate - Validate manifests (structural + behavioral + implementation)
  • maid_snapshot - Generate manifest snapshots from existing code
  • maid_snapshot_system - Generate system-wide architecture snapshot
  • maid_list_manifests - Find manifests referencing a file
  • maid_init - Initialize MAID project structure
  • maid_get_schema - Get manifest JSON schema
  • maid_generate_stubs - Generate test stubs from manifest
  • maid_files - Check file tracking status

Resources (Read-Only Data Access)

  • manifest://{name} - Access manifest content
  • schema://manifest - Get manifest JSON schema
  • validation://{name}/result - Access cached validation results
  • snapshot://system - Get system-wide architecture snapshot
  • graph://query - Query manifest knowledge graph
  • file-tracking://analysis - Get file tracking status

Prompts (Workflow Guidance)

  • plan-task - Guide AI through manifest creation
  • implement-task - Guide AI through implementation
  • refactor-code - Guide AI through safe refactoring
  • review-manifest - Guide AI through manifest review

How It Relates to MAID Runner

Component Role What It Does
MAID Runner Validation framework CLI tool for validating MAID manifests
MAID Runner MCP MCP interface Exposes MAID Runner to AI agents via MCP

MAID Runner MCP doesn't replace the CLI—it complements it:

  • CLI (maid): For humans and shell scripts
  • MCP (maid-runner-mcp): For AI agents and programmatic access

Both use the same underlying validation logic.

Use Cases

1. AI-Assisted Development

AI agents can validate code as they generate it:

# AI agent workflow
result = await session.call_tool("maid_validate", {
    "manifest_path": "manifests/task-013.manifest.json",
    "use_manifest_chain": true
})

if not result["success"]:
    # Fix issues based on errors
    ...

2. Architecture Exploration

AI agents can understand system architecture:

# Get system snapshot
snapshot = await session.read_resource("snapshot://system")

# Query knowledge graph
results = await session.read_resource(
    "graph://query?type=class&name=EmailValidator"
)

3. Workflow Automation

Custom agents can automate MAID workflow:

# Get planning guidance
prompt = await session.get_prompt("plan-task", {
    "goal": "Add email validation"
})

# Follow prompt to create manifest
...

Development

Setup

# Clone repository
git clone https://github.com/mamertofabian/maid-runner-mcp
cd maid-runner-mcp

# Install dependencies
uv pip install -e ".[dev]"

# Run tests
pytest tests/ -v

Makefile Commands

make install      # Install package
make test         # Run tests
make lint         # Check code style
make format       # Format code
make validate     # Validate MAID manifests

MAID Compliance

This project follows the MAID methodology itself:

  • All changes have manifests in manifests/
  • All features have behavioral tests in tests/
  • Validation enforced via maid validate --use-manifest-chain

See CLAUDE.md for development guidelines.

Contributing

See CONTRIBUTING.md for development workflow and guidelines.

License

MIT License - see LICENSE file.

Related Projects

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

maid_runner_mcp-0.1.0.tar.gz (65.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

maid_runner_mcp-0.1.0-py3-none-any.whl (43.6 kB view details)

Uploaded Python 3

File details

Details for the file maid_runner_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: maid_runner_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 65.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for maid_runner_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 70dac26c27c31f3caf6e39e2e8ac91934b26f2c74d994b618b81e136272ecf82
MD5 c7ebc6131814ae6cb89f466e8a47620c
BLAKE2b-256 00a653f256fb90b06c3c77925589c22350151a61da97e4a356d31f4da418e468

See more details on using hashes here.

Provenance

The following attestation bundles were made for maid_runner_mcp-0.1.0.tar.gz:

Publisher: publish.yml on mamertofabian/maid-runner-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file maid_runner_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for maid_runner_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c227ec1697107825f25a35726d3459bbe9823a3d752f78bdd04f97119740174c
MD5 bc8d713a8b9a2d93ec69f97b13836282
BLAKE2b-256 5248f80d63e9e00b262ec994c810c2f3b134064f5fa54554b3bba78a4001236a

See more details on using hashes here.

Provenance

The following attestation bundles were made for maid_runner_mcp-0.1.0-py3-none-any.whl:

Publisher: publish.yml on mamertofabian/maid-runner-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page