Tools
Do not edit this file. pnpm census writes it from the live registries.
Action tools (23)
These tools do work and do not serve a skill. No tool calls a model. The same arguments give the same result with any client.
| Tool | What it does |
|---|---|
rule_tool |
Route prompt to correct rule-mcp skill. |
rule_tool_search |
Semantic search across ALL rule-mcp skills using BM25 ranking. |
rule_tool_check |
Verify code with deterministic guardrail checks, like lint pass, for any rule-mcp skill. |
rule_tool_detect |
Detect project framework, TypeScript usage, and build tool from package.json. |
rule_tool_compress |
Sole compression engine (ADR 107): preprocess enriched prompts/contexts and postprocess model prose. |
rule_tool_fix |
Apply deterministic guardrail fixes of every skill (blank lines, braces, ASCII typography, American spelling) to changed files or explicit list. |
rule_tool_structural |
Declare current task structural or architectural. |
rule_tool_git |
Audit the feature history and normalize it: base branch, merge base, commit range, Conventional Commit violations and merge commits. |
rule_tool_init |
Prepare project for rule-mcp. |
rule_tool_plan |
Ask expert review persona to audit, review or plan this project; returns operation contract. |
rule_tool_audit |
Run audit as expert review persona; returns audit operation contract. |
rule_tool_review |
Run review as expert review persona; returns review operation contract. |
rule_tool_write_plan |
Write durable development plan to docs/plans/_<slug>.md and register it in plan-of-plans.md. |
rule_tool_impersonation |
Create or refresh audit/review/plan documents for review persona run (impersonation bookkeeping). |
rule_tool_stats |
Read the local telemetry log and summarize it: call counts, cache hit rate, saved/estimated tokens, latency. |
rule_tool_keep |
Confirm one decision into export decision-cache (status confirmed, source rule-keep). |
rule_tool_sync |
Check how far base branch has moved since this branch forked, and propose rebase. |
rule_tool_usage |
Declare an agent usage sidecar for this project when no transcript can be read: input/output tokens, cost. |
rule_tool_update |
Force-update this local MCP server to newest release tag (checkout main, pull, reinstall), or fast-forward upstream branch when no tags exist yet. |
rule_tool_handon |
Verify the last session handoff before you resume: check its branch, commit range, files, ADRs and open work. |
rule_tool_handoff |
Close session or generate compressed handoff from ADRs and project context to resume work. |
rule_tool_gateway |
Single-entry orchestrator: make routing decision, load skill evidence, verify code with lint-like guardrail checks, and return receipt. |
rule_tool_apply |
Write files to disk after rule_tool_gateway validation. |
To call a tool from a shell, use rule-mcp tools call <name> --json '{...}'.
rule_tool
Route prompt to correct rule-mcp skill. Returns structured routing with relevant sections.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prompt |
string | yes | - | User's question about frontend development |
framework |
string | no | - | Optional framework hint (react, vue, svelte, angular, etc.) to bias routing |
path |
string | no | - | Optional project path for auto-detecting framework |
rule_tool_search
Semantic search across ALL rule-mcp skills using BM25 ranking. Returns scored, relevant sections.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query |
string | yes | - | Search query to find across all rule-mcp skills |
maxResults |
integer | no | 10 |
Maximum number of ranked results |
rule_tool_check
Verify code with deterministic guardrail checks, like lint pass, for any rule-mcp skill. Project mode checks graph rules; semantic mode offers advisory decision-model check. Re-check until allPass: true.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skill |
string | yes | - | Target rule-mcp skill name |
code |
string | no | - | Code to validate against guardrails (omit with mode=project) |
framework |
string | no | - | Framework (react, vue, svelte, angular, solid, astro, vanilla) |
fileName |
string | no | - | File name for naming convention checks |
isComponent |
boolean | no | - | Whether this is a component file |
mode |
string | no | - | Check mode: 'scaffold' for project config files, 'project' for the graph guardrails, 'semantic' for the advisory decision-model rule |
allowedDependencies |
array of string | no | - | Manifest-derived package names allowed in imports |
projectDir |
string | no | - | Project root for mode=project (default: cwd) |
diagnostics |
boolean | no | - | Run the optional type-checker check in mode=project |
rule_tool_detect
Detect project framework, TypeScript usage, and build tool from package.json.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
path |
string | no | "." |
Project directory path |
rule_tool_compress
Sole compression engine (ADR 107): preprocess enriched prompts/contexts and postprocess model prose. Strip filler and leading articles, replace typographic characters with ASCII, convert British spelling to American. Code, inline spans, URLs and JSON are never touched. Prefer /rule-compress.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
text |
string | yes | - | Prose to compress. Code fences, inline code, URLs and JSON pass through untouched |
mode |
both | compression | fingerprint |
no | "both" |
both (default), compression (filler only), fingerprint (punctuation and spelling only) |
fileName |
string | no | - | Where the prose came from, when it came from a file. A sensitive name (.env, credentials, id_rsa, anything under .ssh) is refused |
rule_tool_fix
Apply deterministic guardrail fixes of every skill (blank lines, braces, ASCII typography, American spelling) to changed files or explicit list.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
files |
array of string | no | - | Files to fix, relative to the project root. Default: the changed files (working tree plus untracked). |
path |
string | no | "." |
Only files under this prefix are touched (default: the whole project) |
mode |
lint | fix |
no | "lint" |
lint: report what a fix would change. fix: write the deterministic fixes. |
dryRun |
boolean | no | - | Preview even in fix mode |
rule_tool_structural
Declare current task structural or architectural. next write asks for one confirmation, stating this summary, and rest of task proceeds without asking again. Call it before changing boundary, contract, dependency or layout, not for ordinary edits.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
summary |
string | yes | - | What is changing and why it is structural, in one sentence the person confirming can judge |
projectDir |
string | no | - | Project root directory |
rule_tool_git
Audit the feature history and normalize it: base branch, merge base, commit range, Conventional Commit violations and merge commits. reword applies proposed messages. linearize removes merge commits. squash closes the feature as one commit and folds the feature's own ADRs and handoffs into one document each (deterministic concatenation, originals deleted, indexes rebuilt). The destructive actions need force:true to be proposed and confirm:true to run. Every rewrite verifies what changed and rolls back on an unexpected path.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir |
string | no | "." |
Project root (default: cwd) |
action |
audit | reword | linearize | squash |
no | "audit" |
audit, reword, linearize, or squash |
force |
boolean | no | false |
Enable a history-normalization proposal (--force) |
confirm |
boolean | no | false |
Required to run a rewrite; the confirmation gate |
baseBranch |
string | no | - | Override the detected base branch |
message |
string | no | - | For squash: the final type(scope): summary |
rewrites |
array of object | no | - | For reword: the message proposed for each commit sha |
rule_tool_init
Prepare project for rule-mcp. Create central recorder directory under state dir. Install or integrate git governance: commit-msg gate and pre-push gate that enforce type(scope): subject. Install Husky only when Node project has no hook mechanism. Migrate leftover local.rule-mcp if present. Run tokensave init when it is installed. Recorder state is never written into repository. Pass noTokensave: true to skip tokensave.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir |
string | no | - | Project root (default: cwd) |
noTokensave |
boolean | no | false |
Skip tokensave init |
rule_tool_plan
Ask expert review persona to audit, review or plan this project; returns operation contract.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role |
string | yes | - | Role id (security, privacy, a11y...) |
years |
integer | no | - | |
skills |
array of string | no | - | |
topic |
string | no | - | Free-text request; becomes the binding scope of the run. Default: the whole project. |
projectDir |
string | no | - | |
operation |
plan | audit | review |
no | - | Which document this run produces: plan, audit, or review (default: all three) |
rule_tool_audit
Run audit as expert review persona; returns audit operation contract.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role |
string | yes | - | Role id (security, privacy, a11y...) |
years |
integer | no | - | |
skills |
array of string | no | - | |
topic |
string | no | - | Free-text request; becomes the binding scope of the run. Default: the whole project. |
projectDir |
string | no | - |
rule_tool_review
Run review as expert review persona; returns review operation contract.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role |
string | yes | - | Role id (security, privacy, a11y...) |
years |
integer | no | - | |
skills |
array of string | no | - | |
topic |
string | no | - | Free-text request; becomes the binding scope of the run. Default: the whole project. |
projectDir |
string | no | - |
rule_tool_write_plan
Write durable development plan to docs/plans/_<slug>.md and register it in plan-of-plans.md. Host CreatePlan files are not source of truth.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
slug |
string | yes | - | Plan file stem; leading _ added if missing. Single segment only. |
title |
string | yes | - | Short plan title used in plan-of-plans snapshot |
body |
string | no | - | Full markdown body (must pass WSn / dual-graph shape) |
topic |
string | no | - | When body is omitted, seed a scaffold that mentions this topic |
overwrite |
boolean | no | - | Replace an existing docs/plans/_slug.md (default false) |
openWork |
string | no | - | Open-work cell for the plan-of-plans snapshot row |
projectDir |
string | no | - |
rule_tool_impersonation
Create or refresh audit/review/plan documents for review persona run (impersonation bookkeeping).
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role |
string | yes | - | Role id |
findings |
array of object | no | - | What this run found. Anything omitted counts as closed - unless a scope is set. |
scope |
string | no | - | The binding scope of a scoped run: findings outside it stay untouched instead of resolving. |
projectDir |
string | no | - |
rule_tool_stats
Read the local telemetry log and summarize it: call counts, cache hit rate, saved/estimated tokens, latency.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope |
session | week | all |
no | "week" |
session\ |
flight |
string | no | - | Path to a .flight file |
rule_tool_keep
Confirm one decision into export decision-cache (status confirmed, source rule-keep).
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fingerprint |
string | yes | - | Stable fingerprint for the decision |
choice |
string | yes | - | The choice to confirm (JSON string if structured) |
agent |
string | no | - | |
projectDir |
string | no | - | Project root; default cwd |
rule_tool_sync
Check how far base branch has moved since this branch forked, and propose rebase. Read-only by default; action: rebase needs confirm: true and refuses on dirty tree. conflict is reported with its files and never resolved automatically.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir |
string | no | "." |
Project root (default: cwd) |
action |
check | rebase |
no | "check" |
check (read-only) or rebase (needs confirm) |
confirm |
boolean | no | false |
Required for action=rebase; the confirmation gate |
baseBranch |
string | no | - | Override the detected base branch |
fetch |
boolean | no | false |
Fetch the base remote first, so the check sees the remote's position |
rule_tool_usage
Declare an agent usage sidecar for this project when no transcript can be read: input/output tokens, cost.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model |
string | no | - | |
provider |
string | no | - | |
apiCalls |
integer | no | - | |
userTurns |
integer | no | - | |
input |
integer | no | - | |
output |
integer | no | - | |
cacheRead |
integer | no | - | |
cacheWrite |
integer | no | - | |
reasoning |
integer | no | - | |
peakContext |
integer | no | - | |
contextWindow |
integer | no | - | |
costUsd |
number | no | - | |
agent |
string | no | - |
rule_tool_update
Force-update this local MCP server to newest release tag (checkout main, pull, reinstall), or fast-forward upstream branch when no tags exist yet. Also runs automatically (throttled, in background) on tool calls; call directly to update on demand.
Takes no parameters.
rule_tool_handon
Verify the last session handoff before you resume: check its branch, commit range, files, ADRs and open work. Close completed audit, review and plan records first, then propose the next plan workstream for confirmation. Never re-run a claimed command.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir |
string | no | "." |
Project root directory |
file |
string | no | - | A specific handoff to read instead of the newest |
list |
boolean | no | false |
List the handoffs and verify nothing |
closeout |
boolean | preview |
no | true |
Archive completed audits/reviews/plans into ADRs, retire them from the plan indexes and delete the sources (default true). "preview" lists what would close out and writes nothing; false skips the sweep entirely |
rule_tool_handoff
Close session or generate compressed handoff from ADRs and project context to resume work. Archive completed audit, review and plan records as ADRs and repair numbering first; pass closeout: false to diagnose without writing.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
projectDir |
string | no | "." |
Project root directory |
mode |
handoff | close-session |
no | "handoff" |
handoff: generate context summary. close-session: the same, with the session-close banner. |
closeout |
boolean | preview |
no | true |
Archive completed audits/reviews/plans into ADRs, retire them from the plan indexes and delete the sources (default true). "preview" lists what would close out and writes nothing; false skips the sweep entirely |
includeContext |
boolean | no | true |
Include .context/ values |
includeAdrs |
boolean | no | true |
Include ADR summaries |
includeIdentity |
boolean | no | true |
Include project identity |
includeGitDiff |
boolean | no | true |
Include git working tree diff |
includeGitLog |
boolean | no | true |
Include recent git log |
includeRoadmap |
boolean | no | true |
Include roadmap/docs scan |
compress |
boolean | no | true |
Aggressively compress output (default: on) |
maxTokens |
number | no | 0 |
Target max tokens (0 = no limit) |
format |
full | brief | minimal |
no | "full" |
Output detail level |
rule_tool_gateway
Single-entry orchestrator: make routing decision, load skill evidence, verify code with lint-like guardrail checks, and return receipt. Use this as primary entry point instead of calling rule-mcp + skill tools separately. returned receipt must be passed to rule_tool_apply when writing files.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prompt |
string | yes | - | Complete coding request |
code |
string | no | - | Code to validate against guardrails (single file) |
files |
array of object | object | no | - | Files to validate - yields a path-bound receipt, required for multi-file writes |
path |
string | no | - | Project path for framework auto-detection |
framework |
string | no | - | Target framework (react, vue, svelte, angular, solid, astro, vanilla, express, fastify, nestjs, hono) |
rule_tool_apply
Write files to disk after rule_tool_gateway validation. Needs valid receipt from rule_tool_gateway proving that code passed all guardrails. receipt is tied to exact code hash - modified code will be rejected. Use dryRun=true (default) to preview without writing.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
files |
array of object | yes | - | Array of files to create/write |
receipt |
string | yes | - | Receipt token from rule_tool_gateway that validated this exact code |
path |
string | no | "." |
Project root directory |
dryRun |
boolean | no | true |
Preview without writing (default: true) |
Skill tools (82)
Each catalog skill has one tool. The tool serves the SKILL.md file and the
sections that a route selects. All skill tools take the same arguments, so this
page groups them by area. The skills page tells what each skill covers.
| Area | Tools |
|---|---|
| ai | rule_tool_ai, rule_tool_ai_agent_architecture, rule_tool_ai_context_engineering, rule_tool_ai_evals, rule_tool_ai_prompting |
| backend | rule_tool_backend, rule_tool_backend_express, rule_tool_backend_fastify, rule_tool_backend_graphql, rule_tool_backend_hono, rule_tool_backend_nestjs, rule_tool_backend_node, rule_tool_backend_security, rule_tool_backend_workers |
| data | rule_tool_data, rule_tool_data_duckdb, rule_tool_data_indexed_db, rule_tool_data_mongodb, rule_tool_data_mysql, rule_tool_data_postgresql, rule_tool_data_sql, rule_tool_data_sqlite, rule_tool_data_validation |
| devops | rule_tool_devops, rule_tool_devops_deploy_preview, rule_tool_devops_docker, rule_tool_devops_observability, rule_tool_devops_testing |
| frontend | rule_tool_frontend, rule_tool_frontend_angular, rule_tool_frontend_react, rule_tool_frontend_solidjs, rule_tool_frontend_svelte, rule_tool_frontend_vue, rule_tool_frontend_workers |
| meta | rule_tool_meta, rule_tool_meta_astro, rule_tool_meta_next, rule_tool_meta_nuxt, rule_tool_meta_remix |
| platform | rule_tool_platform, rule_tool_platform_auth, rule_tool_platform_desktop, rule_tool_platform_library, rule_tool_platform_web |
| process | rule_tool_process, rule_tool_process_adr, rule_tool_process_ai, rule_tool_process_bmad, rule_tool_process_cargo_release, rule_tool_process_changelog, rule_tool_process_code_review, rule_tool_process_npm_release, rule_tool_process_readme, rule_tool_process_tdd, rule_tool_process_uv_release |
| styleguide | rule_tool_styleguide, rule_tool_styleguide_a11y, rule_tool_styleguide_baseline, rule_tool_styleguide_comments, rule_tool_styleguide_configuration, rule_tool_styleguide_css, rule_tool_styleguide_file_tree, rule_tool_styleguide_git, rule_tool_styleguide_html, rule_tool_styleguide_i18n, rule_tool_styleguide_javascript, rule_tool_styleguide_json, rule_tool_styleguide_markdown, rule_tool_styleguide_naming, rule_tool_styleguide_typescript |
| toolchain | rule_tool_toolchain, rule_tool_toolchain_biome, rule_tool_toolchain_eslint, rule_tool_toolchain_husky, rule_tool_toolchain_parcel, rule_tool_toolchain_pnpm, rule_tool_toolchain_rspack, rule_tool_toolchain_turborepo, rule_tool_toolchain_vite |
| ui | rule_tool_ui, rule_tool_ui_design_system |
Arguments, the same for all 82
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
prompt |
string | yes | - | What to build or change in a meta-framework: rendering, routing, data loading, deployment |
framework |
string | no | - | Optional framework hint (astro, next, nuxt, remix) to skip the concept match |