Content
63%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 genuinely actionable integration guide with concrete CLI commands and unusually good connection-state checkpoint handling. Its weaknesses are padding (marketing intro, filler lines), broken step numbering around "Step 2", and a fully monolithic layout with no reference files for the longer API-detail material.
Suggestions
Delete the marketing sentence about engineers/data scientists/sustainability and the filler line "Use action names and parameters as needed"; keep only operationally relevant context.
Fix the broken step numbering: either label the sections (Step 1: connect, Step 2: discover actions, Step 3: run) so "skip to **Step 2**" resolves, or remove the step references.
Move the proxy flag table and the clientAction state documentation into a references/ file (e.g. references/connection-states.md, references/proxy.md) and link them from the body to reduce the monolithic single-file layout.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The commands and tables are tight, but there is real padding: the opening paragraph ("It's used by engineers, data scientists, and operations teams to improve efficiency and sustainability") is marketing fluff, the 24-item resource bullet list ends with the filler line "Use action names and parameters as needed", and the Agent Types note ("Those will be used to adjust tooling to be used best with your harness") is awkward filler. This is more than the 'minor instances' of anchor 4, so it lands on anchor 3. | 3 / 5 |
Actionability | Nearly every section gives copy-paste-ready commands (npm install, membrane login/complete, connection ensure/get --wait, action list/run with --input JSON, request proxy flags), which is mostly executable with minor gaps. It stops short of anchor 5 because `<actionId>`, `<agentType>`, and `CONNECTION_ID` are left as unexplained placeholders and the text references a "**Step 2**" that is never defined. | 4 / 5 |
Workflow Clarity | The fragile part of the workflow — connection setup — has an explicit state machine with checkpoints: poll with --wait, handle CLIENT_ACTION_REQUIRED by surfacing uiUrl/agentInstructions, re-poll, and treat CONFIGURATION_ERROR/SETUP_FAILED via the error field. This satisfies anchor 4 (clear sequence, most checkpoints) but not anchor 5, since the numbered steps are broken ("skip to **Step 2**" points at no Step 2, a "1b" exists with no Step 1 or 2 labels) and running actions has no error-recovery guidance. | 4 / 5 |
Progressive Disclosure | The body is ~160 lines in a single file with no bundle files at all — the proxy flag table, the clientAction state reference, and the resource-type index are inline material that would fit a references/ file, and the only external pointer is the Cognite docs URL. This matches anchor 3 (some structure, but content that should be separate is inline); it is not anchor 4's 'most content appropriately placed' since nothing is split out. | 3 / 5 |
Total | 14 / 20 Passed |