magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
2 min read

leak

An advisory by default: it explains, and blocks nothing, on residue of a tool or a template: a citation marker or an unfilled placeholder.

What it catches

Residue of a tool or a template: a citation marker or an unfilled placeholder.

Dimension

evidence: a claim says more or less than what was shown. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

oaicite, [cite: 1] and [insert ...] are unambiguous: no reader is served by them. They show up where text was pasted from a chat, so the rule judges doc comments too. Measured 2026-10-10: 100% precision on its cases (6 of 6), but agent replies' link text naming a file and line ([describe.go:668]) read as a [describe ...] placeholder, and of 71 AIDev pull request candidates many lenticular-bracket hits were CJK punctuation around a label. A placeholder word now ends at a space, a colon or the bracket, and a lenticular pair counts only around a dagger. Firing rates after are measured at merge.

Default decision

The code is PRF4005. The decision depends on the kind of text judged:

Kind Default
doc-comment advise
reference advise
principle advise
guide advise
change-description advise
agent-brief advise
agent-compact advise
commit-message advise
issue advise
release-notes advise
changelog advise
cli-help advise
review-summary advise
review-inline advise
review-reply advise
agent-reply advise

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"leak": "deny"},
  "paths": {"blog/**": {"leak": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "leak", "code": "PRF4005", "decision": "advise", "url": "https://eli.gladman.cc/magus/reference/proofread/leak/"}

proofread rules prints this entry with every other rule's.

See also

proofreadrulesleakadvise
Last updated (2df714e8)
Earlier changes on this page (3)

Full history ↗ · Blame source ↗

Glossary

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Agent

A model working through an agent host such as Claude Code, Codex, Cursor or OpenCode. magus treats an agent as one more caller of its CLI, MCP tools and console, held to the same checks as a person. Agent in full.

Tool

An action a model can call through its host: a name, a description, a typed input and a result. magus serves its tools over MCP, each a read of the workspace model or a run of the CLI it already has. Tool in full.

Lease

The grant a holder takes on a job: the write and read paths that job declared, enforced in the checkout that took it with magus job exec. A job is the piece of work; a lease is permission over it. Lease in full.

Advisor

One read-only check from the advice suite: it reads the changeset through magus and writes one titled section of findings. The same advisors run as a pull request comment in CI and inside magus diff --impact locally. Advisor in full.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.