Content
73%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 strong, executable guide with an excellent connection-state workflow and feedback loops. Its main weakness is token efficiency: an introductory concept dump and motivational phrasing add tokens Claude does not need.
Suggestions
Trim the opening paragraph ("Shipcloud is a shipping platform...") and motivational phrases like "so you can focus on the integration logic rather than auth plumbing"; Claude already knows what a shipping platform is.
Remove low-value filler such as "Use action names and parameters as needed."
Optionally move the proxy request flag table and detailed clientAction field descriptions into a references/ file to shorten the main body while keeping it one level deep.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Mostly efficient command-driven content, but padded with an unnecessary intro paragraph explaining what Shipcloud is and rhetorical flourishes like "so you can focus on the integration logic rather than auth plumbing." | 3 / 5 |
Actionability | Provides concrete, copy-paste-ready membrane CLI commands with flags, JSON examples, and a flag table, with only minor gaps around interpreting output schemas. | 4 / 5 |
Workflow Clarity | Clear multi-step sequence from install through connection-state handling, with an explicit state machine and feedback loops (poll again after user completes the action) for error recovery. | 5 / 5 |
Progressive Disclosure | Well-organized into clear single-level sections with no nested references and easy navigation, though the ~150-line self-contained file inlines some CLI reference material that could optionally live in a reference file. | 4 / 5 |
Total | 16 / 20 Passed |