Content
67%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.
The body is a well-structured, highly actionable command reference with explicit workflows, validation checkpoints, and error-recovery guidance. Its main weaknesses are a factual contradiction on the search retmax default, a malformed count example, and quadruplicated API-key instructions.
Suggestions
Resolve the retmax contradiction: 'Core Rules' says search 'defaults to --retmax 200' while the search section says 'Default is 0, which means fetch all matching results' — pick one and delete the other.
Consolidate the four repetitions of the NCBI_API_KEY/credentials protocol into a single section and cross-reference it from the other spots, cutting substantial tokens.
Fix the count example so it is a proper multi-line code block like the search examples, and either link references/citation.bib from the body or remove it from the bundle.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Mostly efficient operational detail, but the NCBI_API_KEY/credentials instruction is repeated four times (Prerequisites, Core Rules, 'Obtaining and Using an API Key', Common Mistakes) and the Overview briefly explains what ClinVar is — noticeable padding that could be consolidated. | 3 / 5 |
Actionability | Nearly all commands are copy-paste ready with full flags, output schemas, and a concrete dbSNP fallback (`uv run scripts/dbsnp_cli.py resolve-rsid {rsid}`), but the `count` example is malformed into a single line with literal backslashes, and 'Core Rules' contradicts the search docs on the retmax default (200 vs 0/fetch-all). | 4 / 5 |
Workflow Clarity | Clear multi-step sequences with explicit validation checkpoints ('always verify these match to confirm complete retrieval', HGVS cross-checks, single-turn triangulation) and a 429 error-recovery loop, but the contradictory retmax default gives conflicting instructions on a core parameter of the recommended Count-First workflow. | 4 / 5 |
Progressive Disclosure | Good section structure with the bundled script (scripts/clinvar_api.py) clearly signaled and used throughout; however references/citation.bib exists in the bundle but is never referenced in the body, a minor organization gap. | 4 / 5 |
Total | 15 / 20 Passed |