CONTRIBUTING.md

Contributing

Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'   # includes pytest; use '.' for core only

Commands

agentbreak init                    # create .agentbreak/ config
agentbreak verify                  # run pytest
agentbreak validate                # check config
agentbreak inspect                 # discover MCP tools
agentbreak serve                   # start proxy

Repo Layout

Path	Role
agentbreak/main.py	CLI (serve, validate, inspect, verify), FastAPI app, proxy logic
agentbreak/config.py	application.yaml Pydantic models, registry I/O
agentbreak/scenarios.py	scenarios.yaml schema and validation
agentbreak/behaviors.py	Response mutation helpers
agentbreak/discovery/mcp.py	MCP server inspection
tests/	Pytest suite (agentbreak verify runs these)
examples/	LangChain, LangGraph, MCP servers

Guidelines

• Keep the product surface small.
• Prefer one clear path over several aliases or modes.
• Keep scenarios explicit and typed.
• Preserve test isolation so agentbreak verify stays deterministic.
• Update docs when config shape or fault types change.

See also AGENTS.md and docs/README.md.