Content
82%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: every operation has executable examples, defaults and user-facing flags are explicitly governed by Core Rules, and detailed endpoint material is correctly offloaded to a clearly signaled one-level-deep reference file. Remaining weaknesses are minor — a few trimmable concept definitions, no explicit error-recovery guidance, and one unmentioned bundle file.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is dominated by commands, flags, and runnable examples that earn their tokens, with only minor over-explanation: the 'Key Concepts' section defines ENSG/ENST/ENSP stable-ID basics Claude already knows, and the Overview paragraph partially repeats the frontmatter description. This matches the 4 anchor (efficient with minor trimmable instances) better than 3, since there is no padded fluff or unsolicited commentary. | 4 / 5 |
Actionability | Every command (resolve-gene, map-id, get-sequence, gene-summary, transcripts, canonical-tss, transcript-structure, protein-info, protein-sequence, vep) has copy-paste-ready 'uv run scripts/ensembl_api.py ...' invocations with realistic arguments and useful variants (symbol vs. ENSG input, --assembly GRCh37, --only-mane), plus a concrete VEP stdout sample and jq/python parsing guidance. This fully matches the 5 anchor: executable and covering the common cases. | 5 / 5 |
Workflow Clarity | Commands chain naturally through consistent example IDs (TP53 → ENSG00000141510 → ENST00000269305) and the Core Rules impose explicit output checkpoints ('MUST explicitly flag this default', 'show the complete list'), giving a clear sequence. It falls short of 5 because there is no explicit multi-step recipe or error-recovery loop for API failures (e.g., what to do on a failed resolve or a 429), and it is above 3 since no destructive or batch operations are involved and checkpoints are present. | 4 / 5 |
Progressive Disclosure | The full API endpoint reference is appropriately split into references/ensembl_rest_api_reference.md (verified to exist, 325 lines), clearly signaled in the Custom Queries section and one level deep, keeping the body a lean command overview. The minor gap keeping it at 4 rather than 5 is that references/citation.bib exists in the bundle but is never referenced in the body, leaving a small navigation hole. | 4 / 5 |
Total | 17 / 20 Passed |