Content
68%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 solid, command-driven guide: install, authenticate, connect, poll for readiness, discover actions, run them, and fall back to the proxy, each with executable commands and good state-based checkpoints. Its main weaknesses are incoherent step references ('Step 2', '1b' with no numbered steps), inconsistent CLI invocation styles, and a few padded or duplicated sections.
Suggestions
Fix the dangling step references: 'skip to Step 2' and the '1b' heading point to step labels that don't exist — either number the workflow steps explicitly (1. Install, 2. Authenticate, 3. Connect...) or drop the numbering.
Pick one CLI invocation ('membrane' vs 'npx @membranehq/cli@latest') and use it consistently throughout.
Remove the empty '## Popular actions' heading (its body duplicates the search command from 'Searching for actions') and tighten the intro paragraph and agent-types aside; add one worked example with a real action id and intent query.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Mostly efficient — commands and the proxy flag table are tight — but several parts are trimmable: the intro paragraph explaining what the app is for, the '## Popular actions' heading whose body just repeats the `action list` command already shown in 'Searching for actions', and the informal aside on agent types ('Those will be used to adjust tooling to be used best with your harness'). Falls between anchor 3 ('some unnecessary explanation or could be tightened') and anchor 4 ('minor instances of over-explanation'). | 3.5 / 5 |
Actionability | Nearly every step has a copy-paste command ('npm install -g @membranehq/cli@latest', 'membrane connection ensure "https://ecartapi.com/" --json', 'membrane action run <actionId> --connectionId=CONNECTION_ID --input \'{"key": "value"}\' --json') plus a flag table for proxy requests, matching 'Mostly executable guidance; concrete code or commands with minor gaps'. Not 5 because there is no worked example with a real action id or intent query, so the placeholders CONNECTION_ID and QUERY are never exercised end-to-end. | 4 / 5 |
Workflow Clarity | The sequence (install → login → connection ensure → poll state → search actions → run → proxy fallback) is present with state-based checkpoints ('READY', 'CLIENT_ACTION_REQUIRED', 'CONFIGURATION_ERROR or SETUP_FAILED — check the error field', 'Keep polling until state is no longer BUILDING'). But the doc references 'skip to Step 2' and a '#### 1b' heading while no section is ever labeled Step 1, 2, or 1a — the step numbering is incoherent — and it switches between 'membrane' and 'npx @membranehq/cli@latest' invocations without reconciliation. Falls between anchors 3 and 4. | 3.5 / 5 |
Progressive Disclosure | No bundle files exist (no references/, scripts/, or assets/ directories), so all content is inline in a ~140-line body organized under clear headings (Install, Authentication, Connecting, Searching for actions, Running actions, Proxy requests, Best practices) with an external link to official docs — matching 'Good structure; most content is appropriately placed; minor organization gaps'. Not 5 because the empty '## Popular actions' section that nests '### Running actions' is an organization gap, and the connection-state handling detail is borderline content that could live in a reference file. | 4 / 5 |
Total | 15 / 20 Passed |