Content
72%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 well-structured and mostly actionable, with good progressive disclosure via real reference files and scripts. Its main weaknesses are mild cross-section redundancy, an unexplained hidden dependency in the annotation example, and absent validation steps for a batch annotation operation.
Suggestions
Merge the overlapping 'Key Features' and 'Implementation Details' descriptions of search/annotation into a single section to remove redundancy and tighten token use.
Show how to obtain the ClinVar VCF used for annotation (e.g., the bulk FTP download path from references/api_reference.md) or pass it via --clinvar, so the annotate example is fully executable end-to-end.
Add a verification step to the annotation workflow, such as confirming the output VCF is valid and that annotations were applied (e.g., a bcftools view/validate check), to satisfy validation expectations for a batch operation.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Avoids tutorial padding about what VCF/bcftools/E-utilities are, but the 'Key Features' and 'Implementation Details' sections restate the same search/annotation descriptions, a redundancy that could be trimmed; fits the 'efficient, minor instances of over-explanation' anchor rather than the fully lean 5. | 4 / 5 |
Actionability | Provides two concrete, mostly copy-paste commands ('python scripts/search.py --term ...', 'python scripts/annotate.py --input ... --output ...'), but the annotation example hides an unexplained dependency (the script defaults clinvar_vcf to 'clinvar.vcf.gz') so it is not fully executable end-to-end, leaving it just below the 5 anchor. | 4 / 5 |
Workflow Clarity | Operations are presented as independent example commands rather than a sequenced workflow, and the body omits any validation/verification step or feedback loop for VCF annotation, a batch operation; per the batch-operation cap, workflow clarity cannot exceed 3. | 3 / 5 |
Progressive Disclosure | Clear overview with well-signaled, one-level-deep references to real bundle files ('references/api_reference.md', 'references/clinical_significance.md') and scripts, with content appropriately split into separate reference files and easy navigation. | 5 / 5 |
Total | 16 / 20 Passed |