Content
61%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 well-structured, actionable body with real one-level-deep references and executable examples for the main workflows. Its weaknesses are duplicated content that inflates token cost and missing validation/verification checkpoints in the batch and annotation workflows.
Suggestions
Add validation steps to the batch workflows — verify downloaded files (checksums/file size) and confirm annotation applied (e.g., count annotated records with `bcftools query -f '%CLNSIG' | grep -c Pathogenic`) — to lift workflow clarity past the batch-operation cap.
Deduplicate content: star ratings, rate limits, and FTP file listings each appear in multiple sections and partly duplicate the reference files; keep the body lean and defer detail to the references.
Fix the first `bcftools annotate` example (it lacks the header lines/-c column spec needed to run as written) and replace the deprecated PyVCF example with a maintained library (e.g., cyvcf2).
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is mostly efficient with concrete examples, but includes unnecessary repetition — star ratings and API rate limits each appear in multiple sections, and the Resources section re-describes reference files already pointed to inline — so it fits the 'mostly efficient but could be tightened' anchor rather than the lean 4-anchor. | 3 / 5 |
Actionability | Concrete, mostly copy-paste-ready curl, wget, bcftools, pandas, and awk examples cover the common cases, but minor gaps exist: the first `bcftools annotate` example omits header specification, the awk example uses unexplained hardcoded column indices ($7/$13), and PyVCF is a deprecated library — matching 'mostly executable with minor gaps'. | 4 / 5 |
Workflow Clarity | Workflow examples present clear numbered sequences (e.g., Example 2's download → annotate → filter), but batch operations such as the bulk download/local-database build (Example 4) and VCF annotation lack validation or verification steps (no integrity checks, no confirmation the annotation applied), so workflow clarity is capped at 3 per the batch-operations guideline. | 3 / 5 |
Progressive Disclosure | The body is a well-organized overview that clearly signals three real, one-level-deep references at the point of use ("Refer to `references/api_reference.md`..."), matching 'good structure, references mostly clear'. Minor gaps: some FTP directory and format detail duplicates what belongs solely in `data_formats.md`. | 4 / 5 |
Total | 14 / 20 Passed |