Content
85%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
A lean, operational runbook with pinned executable commands, explicit pre-change inspection of side effects, a dedicated verification section with fallback behavior, and a single well-signaled reference file. The weakest areas are minor: version-pin/cryptic phrasing in prose and the sync command not being spelled out in full.
Suggestions
Isolate the pinned version in one place (or a short pinned-version note) instead of restating @1.6.0 in prose, and rewrite insider phrasing like "upstream savings are not an Arnesto benchmark" so the sentence is self-contained.
Show the full command `npx --yes @colbymchenry/codegraph@1.6.0 sync .` rather than referring to `sync .` in prose, and include one short example of expected `query --json` output so success is recognizable.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean and assumes competence ("Prefer `rg` for a simple literal lookup; do not create an index merely because the tool exists"), but the version pin "@colbymchenry/codegraph@1.6.0" also appears in prose outside any old-patterns/deprecated section, and the closing line "upstream savings are not an Arnesto benchmark" is cryptic. Not 5 because of these minor time-sensitive/trimmable elements; not 3 because there is no padded explanation of concepts Claude already knows. | 4 / 5 |
Actionability | Provides copy-paste-ready pinned commands for init/status/query/callers along with the required environment exports, but "run `sync .` with the same version and environment" leaves the sync command to be reconstructed, and no expected `--json` output shape is shown. Not 5 because of these minor gaps; not 3 because the primary commands are fully executable and complete. | 4 / 5 |
Workflow Clarity | Clear scope → CLI → MCP → verify sequence with explicit validation ("Confirm non-zero indexed files/nodes, resolve a known symbol to its real file, and check at least one known caller") and error-recovery loops ("Fall back to source search if indexing fails or the language is unsupported"; "Do not treat an empty or stale index as evidence of no callers"). Not 4 because checkpoints and fallbacks are explicit rather than implicit. | 5 / 5 |
Progressive Disclosure | A well-organized ~65-line overview with a single clearly signaled one-level-deep reference — "See [usage and sources](references/usage.md) for setup and test evidence" — and the referenced file exists in the bundle with no further nesting. Not 4 because navigation is unambiguous and the operational/evidence split is appropriate; the only redundancy (env vars and the init --yes warning repeated in the reference) is minor. | 5 / 5 |
Total | 18 / 20 Passed |