Content
50%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 content is strong on actionability with real executable code and concrete examples, but it is padded with redundant generic boilerplate and templating artifacts, and its workflow lacks explicit validation checkpoints for batch API operations. Progressive disclosure is mediocre because detailed material is inlined and references are not linked to specific files.
Suggestions
Cut the redundant generic sections (When to Use, Key Features, Implementation Details, Output Requirements, Response Template, Evaluation Criteria, Lifecycle Status) and remove the stray '\n\.' artifacts.
Add an explicit validation checkpoint to the workflow for batch_query results (e.g. verify API responses, retry on rate-limit, confirm each variant resolved).
Move the large ACMG criteria tables and full output-JSON example into references and link them by filename instead of inlining.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is noticeably verbose: many redundant boilerplate sections (When to Use, Key Features, Implementation Details, Output Requirements, Response Template, Evaluation Criteria, Lifecycle Status, Risk Assessment, Security Checklist) repeat generic process advice Claude already knows, with filler like "See `## Prerequisites` above for related details." and stray "\n\." artifacts. | 2 / 5 |
Actionability | It provides concrete, mostly executable guidance: a real `scripts/main.py`, a Python API example (`from scripts.main import VariantAnnotator`; `annotator.query_variant(...)`), CLI commands (`python scripts/main.py --variant rs80357410`), an input-format table, and a full output-JSON example, with only minor gaps such as the odd example directory path. | 4 / 5 |
Workflow Clarity | A 5-step Workflow plus Error Handling and Input Validation sections give a rough sequence, but the steps are generic and lack concrete validation checkpoints; because batch_query is a batch operation with no explicit result-validation step, workflow clarity is capped at 3. | 3 / 5 |
Progressive Disclosure | Bundle files exist (references/acmg-guidelines.md, clinvar-guide.md, example-variants.md, hgvs-nomenclature.md; scripts/main.py) and a References section points to them, but references are signaled generically ("See `references/` for...") without named file links, and large content like the ACMG criteria tables and output JSON is inlined rather than split out. | 3 / 5 |
Total | 12 / 20 Passed |