User Guide¶
This guide starts with MCP workflows, then covers CLI usage, configuration, language support, and AI-assisted remediation1.
-
MCP Tools Reference
All tools, resources, and prompts available to MCP clients and agents.
-
CLI Reference
Every command, flag, and exit code — with usage scenarios.
-
Configuration
Tune thresholds per language, set CI profiles, and manage monorepo configs.
-
Languages
Programming, workflow, and config coverage — each with its own zen philosophy.
-
Rules
The 10 universal dogmas and per-language zen principles that drive every detector.
-
Understanding Violations
How to read severity scores, what principles mean, and what to fix first.
-
Prompt Generation
Generate AI-ready remediation prompts from analysis results.
-
Examples
End-to-end workflows: single file, project report, CI pipeline.
Recommended learning path
New user? Start with MCP Tools Reference → CLI Reference → Configuration. Adding a language? Go directly to Languages to find your language's principles and detectors.
Use one zen-config.yaml at the repository root and run zen reports ..
Keep one config per package and pass --config path/to/zen-config.yaml from each CI job.
See Also¶
- Getting Started — Fast path from installation to first report.
- Languages — Per-language principles, detectors, and style-guide provenance.
- MCP Tools Reference — All MCP tools, resources, and prompts at a glance.
- API Reference — Python and MCP integration examples.