Content
76%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 well-structured, highly actionable body with executable examples and sound progressive disclosure, weakened mainly by missing validation/feedback loops for its batch and broadcast operations. Tightening the redundant intro and adding verification steps for bulk/broadcast would raise it further.
Suggestions
Add a validation/feedback step for batch operations — e.g. check triggerBulk/triggerBroadcast response statuses and retry or surface failures — to lift workflow_clarity above the batch cap.
Show a chunking example for batches larger than 100 events rather than only mentioning the limit in Common Pitfalls.
Trim the redundant opening paragraph that restates the description and the section headers, or fold it into a single one-line orientation.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | Largely lean and code-first with no padding about concepts Claude already knows, but the opening line ('Send notifications by triggering Novu workflows. Supports single, bulk, broadcast, and topic-based delivery.') repeats the description and the section headers that immediately follow. | 4 / 5 |
Actionability | Fully executable, copy-paste-ready TypeScript using the real '@novu/api' SDK across setup, single, inline-subscriber, transaction-id, bulk, broadcast, topic, cancel, and overrides — covering the common cases comprehensively. | 5 / 5 |
Workflow Clarity | Sections are clearly organized by task type, but batch and broadcast operations (bulk up to 100 events, broadcast to all subscribers) lack validation/verification checkpoints or feedback loops, so the rubric's batch-operations cap applies. | 3 / 5 |
Progressive Disclosure | Clear sections plus a dedicated References block pointing to one-level-deep, verified files (installation, single/bulk/topic examples, best-practices), with only minor overlap between the inline examples and the example reference files. | 4 / 5 |
Total | 16 / 20 Passed |