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.
The body is well organized with a genuinely runnable example that matches the bundled script, and the field reference is properly offloaded. Weaknesses are a hedged, partially redundant Implementation Details section, a workflow with no validation checkpoints for batch XML mining, and an example that covers only one of the parser's search modes.
Suggestions
Trim or remove the "Implementation Details" section (especially the conceptual spectral-analysis bullet) since the parser code and references/hmdb_data_fields.md already convey this information.
Extend the example to cover the parser's other mode — parser.search("HMDB0000001", search_type="id") — and show how to access specific extracted fields, so the common cases are covered copy-paste ready.
Add validation checkpoints to the workflow: verify the downloaded XML exists and parses before mining, and note the memory/time cost of the full HMDB dump with an error-recovery path.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is mostly efficient (When to Use, a runnable example, a pointer to the field reference), but the "Implementation Details" section restates what the code and reference file already show in hedged prose ("typically matches", "as supported by the parser/search implementation"), and the "Spectral analysis (conceptual)" section is speculative padding ("can be extended... not guaranteed unless implemented"). | 3 / 5 |
Actionability | The Python example is real and matches the bundled parser ("parser.search(\"Caffeine\")" against scripts/hmdb_parser.py), and the download URL is given, so guidance is mostly executable. Minor gaps: only name search is shown — the parser's ID search (search_type="id") and extraction of chemical/biological/clinical fields beyond the five returned keys are not demonstrated. | 4 / 5 |
Workflow Clarity | A rough sequence exists (download XML → save as data/hmdb_metabolites.xml → run parser), with only an implicit empty-results check as validation. The workflow involves batch processing of a very large XML dump with no verification checkpoints (confirm the file exists/is parseable, handle download or parse failures), which caps this at the anchor-3 level per the batch-operations guideline. | 3 / 5 |
Progressive Disclosure | Good structure against the actual bundle: the field reference is clearly signaled and one level deep ("see: references/hmdb_data_fields.md", which exists), and the parser code lives in scripts/hmdb_parser.py as referenced by the import. Minor gaps: the parser script is never explicitly pointed to as a bundle file, and the inlined conceptual Implementation Details content duplicates what belongs in the reference. | 4 / 5 |
Total | 14 / 20 Passed |