Reference
This handbook tells how RuleMCP works and how to use it. The text comes from the source code and the tests.
Use the server
- Getting started: install the server and connect an agent
- Architecture: the path of a request
- Agent instructions: the rules that an agent receives
- Install and uninstall: what the installer writes and removes
- Features and attribution: the user-facing switches
- Integration levels: how deep a host can go
- Custom skills: add your own rules
- Release: publish a version and the documentation site
- Troubleshooting: find and fix problems
- Environment variables: the
RULE_MCP_*settings - Privacy: what the server records and how to erase it
- Engineering guides: how to work on this repository
Generated inventories
The census writes these pages from the live registries. Do not edit them.
- Skills: the catalog by area
- Tools: each action tool with its parameters
- Prompts: each prompt that the server serves
- Instructions: the slash commands and the hooks
- CLI: each command, flag, and default
- Personas: the review roles and their lenses
- Guardrails: the rules that a check runs
- Resources: the
rule://surface - Surface map: the counts, then each command, tool, and skill
- Install targets: each agent and its integration ceiling
- Environment readers: where the code reads each variable
The site shows pages 3 and 16 as one Instructions page.