Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Maid Runner

FreeNot checked

Exposes MAID Runner validation tools (validate, snapshot, test) as MCP tools, resources, and prompts for AI agents like Claude Code and Aider, enabling seamless

GitHubEmbed

About

Exposes MAID Runner validation tools (validate, snapshot, test) as MCP tools, resources, and prompts for AI agents like Claude Code and Aider, enabling seamless integration with AI development workflows.

README

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

from github.com/mamertofabian/maid-runner-mcp

Install Maid Runner in Claude Desktop, Claude Code & Cursor

Recommended · one command, every IDE
unyly install maid-runner-mcp

Installs into Claude Desktop, Claude Code, Cursor & VS Code — handles npx, uvx and build-from-source repos for you.

First time? Get the CLI: curl -fsSL https://unyly.org/install | sh

Or configure manually

Run in your terminal:

claude mcp add maid-runner-mcp -- uvx maid-runner-mcp

FAQ

Is Maid Runner MCP free?

Yes, Maid Runner MCP is free — one-click install via Unyly at no cost.

Does Maid Runner need an API key?

No, Maid Runner runs without API keys or environment variables.

Is Maid Runner hosted or self-hosted?

Self-hosted: the server runs locally on your machine via the install command above.

How do I install Maid Runner in Claude Desktop, Claude Code or Cursor?

Open Maid Runner on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare Maid Runner with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All development MCPs