Content
75%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 thorough, highly actionable reference with executable commands, clear workflows, and useful validation/error-recovery guidance. The main drags are repetition (the credentials protocol appears three times) and a dangling `citation.bib` bundle file that the body never points to.
Suggestions
Consolidate the NCBI_API_KEY / safe-credentials protocol into a single section and reference it from Prerequisites and Core Rules instead of repeating the full instructions three times.
Reference `references/citation.bib` from the body (e.g. in Overview or a Citations section) so the bundle file is discoverable and not orphaned.
Inline the "verify total_count == fetched_count" check as an explicit numbered validation step inside the Count-First workflow rather than only mentioning it in Best Practices.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is mostly efficient reference material, but the safe-credentials NCBI_API_KEY instruction is repeated three times (Prerequisites, Core Rules, Obtaining and Using an API Key), the Overview explains what ClinVar is (which Claude already knows), and several defaults are restated in multiple sections — tightening would remove noticeable padding. | 3 / 5 |
Actionability | Every subcommand has copy-paste-ready `uv run scripts/clinvar_api.py …` invocations with concrete queries, full argument tables, and explicit output schemas covering the common search/count/summary/evidence cases. | 5 / 5 |
Workflow Clarity | The Count-First and Triangulation workflows are clearly sequenced with commands, and the 429 → credentials → retry path is an explicit error-recovery feedback loop; however the "verify total_count == fetched_count" checkpoint and the retmax-completeness check live in Best Practices rather than inline as numbered validation steps within the workflows. | 4 / 5 |
Progressive Disclosure | Section structure is good (Prerequisites, When to Use, Quick Start, Utility Scripts, Workflows, Best Practices, Common Mistakes) and `scripts/clinvar_api.py` is clearly referenced and exists, but `references/citation.bib` is present in the bundle yet never referenced or signaled in the body, and the detailed per-command output schemas could arguably live in a reference file. | 4 / 5 |
Total | 16 / 20 Passed |