Content
85%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 strong, highly actionable body: executable code, a sequenced workflow with error-recovery loops, and non-obvious gotchas (raw-query requirement, nullable-prop rule) that Claude could not infer. The weaknesses are a dangling generic reference to rules/<rule-name>.md with no bundle files present, and minor internal duplication of the MetricType guidance.
Suggestions
Fix the dangling reference: either ship rules/workflow.md in the bundle or name the concrete path (e.g. 'Read rules/workflow.md') instead of the generic 'rules/<rule-name>.md' placeholder, so the pointer resolves to a real file.
Consolidate the MetricType guidance (kq.metrics("<Type>") auto-pinning) into one section — it is currently repeated in rule 1, Backend caveats, and Workflow step 1 — to trim token overhead.
If the per-component props matrix grows, move the full prop reference into a bundled reference file and keep SKILL.md as the overview with a clearly signaled, one-level-deep link.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is dense and assumes competence — no generic OTel/dashboard tutorials — but the MetricType guidance ('Choose the MetricType up front via kq.metrics("Gauge")') is stated three times (rule 1, Backend caveats, Workflow step 1) and rule #2 is restated in the Components section. This fits 'efficient; minor instances of over-explanation that could be trimmed' rather than 'every token earns its place'. | 4 / 5 |
Actionability | Fully executable, copy-paste-ready guidance: a complete runnable Quick Example ('npx tsx create-cpu-dashboard.mts'), exact commands (npm i @kopai/sdk, the CLI fallback one-liner), concrete kq chains per tile type in the components table, and quoted render-time error messages that make failure modes actionable. Common cases are covered. | 5 / 5 |
Workflow Clarity | The five-step workflow (discover → build queries → assemble uiTree → create → view) has an explicit error-recovery feedback loop: 'On a KopaiValidationError/KopaiError, re-run discoverMetrics() to recheck names and types, fix the tree, and retry', plus backend-connection error guidance embedded in the dynamic commands. Sequence and checkpoints are explicit. | 5 / 5 |
Progressive Disclosure | The '## Rules' section points to 'Read rules/<rule-name>.md for details', but no rules/ directory (nor any references/scripts/assets bundle) exists, so the pointer is generic and dangling — a navigation dead-end that fits 'references present but not clearly signaled'. The rest of the structure (sections, table, dynamic schema/metrics injection) is reasonable, keeping it above anchor 2. | 3 / 5 |
Total | 17 / 20 Passed |