novu-framework-integration

Build code-first notification workflows with @novu/framework. Use when defining workflows in TypeScript (Zod / JSON Schema / Class Validator), composing channel steps (email, SMS, push, chat, in-app) with action steps (delay, digest, custom), exposing Step Controls for non-technical teammates, rendering React/Vue/Svelte Email templates, hosting the Bridge Endpoint inside Next.js, Express, NestJS, Remix, Nuxt, SvelteKit, H3, or AWS Lambda, syncing to Novu Cloud via CLI / GitHub Actions, securing production with HMAC, or implementing translations, hydration, multi-channel orchestration, and LLM-powered notification logic in code.

Quality

92%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Low

Low-risk findings worth noting

Quality

Content

85%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is highly actionable and well-structured with strong progressive disclosure and clear sequenced workflows. Its main weakness is conciseness — substantial inline content (particularly the eight per-framework serve snippets) overlaps with existing reference files and could be moved out.

Suggestions

Move the eight per-framework `serve` wrapper snippets (Next.js App/Pages, Express, NestJS, Remix, SvelteKit, Nuxt, H3, Lambda) into references/bridge-endpoint.md, keeping only the most common one or two inline with a pointer to the rest.

Tighten the Channel Steps and Step Options sections by moving the per-step output tables into references/workflow-and-steps.md, leaving a concise summary plus one representative example in the body.

Consolidate the repeated EU-region guidance (api-url / dashboard-url) into a single note in references/deployment.md rather than restating it inline in the Studio, sync, and Client sections.

Dimension	Reasoning	Score
Conciseness	The body is dense and avoids explaining concepts Claude already knows, but at ~830 lines it inlines considerable material that duplicates existing references — notably all eight framework `serve` snippets, which belong in bridge-endpoint.md — pushing it into the "mostly efficient but could be tightened" anchor rather than fully lean.	2 / 3
Actionability	Provides fully executable, copy-paste-ready code for every step type and framework plus concrete commands such as `npx novu init --secret-key=...` and `npx novu@latest sync --bridge-url ...`, matching the anchor for complete, specific, executable guidance.	3 / 3
Workflow Clarity	Multi-step processes are clearly sequenced ("How It Works" 1-4, Quick Start 1-5, GitOps 1-3) with validation/feedback checkpoints via the Local Studio ("trigger test events", Sync button), HMAC verification guidance, and the Common Pitfalls list for error recovery.	3 / 3
Progressive Disclosure	SKILL.md serves as a clear overview with well-signaled, one-level-deep references to nine verified reference files (e.g., "See [`references/bridge-endpoint.md`]"), and a final References list; content is appropriately split with deeper detail pushed to the references.	3 / 3
	Total	11 / 12 Passed

Description

100%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is specific, trigger-rich, and clearly delineates both what the skill does and when to use it within a distinctive Novu-framework niche. Its only risk is over-density — the long enumeration of frameworks and features borders on verbosity — but every element is concrete and trigger-relevant.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete actions such as "composing channel steps (email, SMS, push, chat, in-app) with action steps (delay, digest, custom)", "rendering React/Vue/Svelte Email templates", and "hosting the Bridge Endpoint inside Next.js, Express, NestJS…", matching the anchor for listing several specific concrete actions.	3 / 3
Completeness	Clearly states what it does ("Build code-first notification workflows with @novu/framework") and when to use it (the explicit "Use when…" clause), satisfying both the what and the when with explicit triggers.	3 / 3
Trigger Term Quality	Natural user-facing terms are well covered — "notification workflows", "email, SMS, push", "React Email", "Next.js, Express", "HMAC" — alongside an explicit "Use when defining workflows in TypeScript (Zod / JSON Schema / Class Validator)" trigger clause, giving good coverage of terms users would actually say.	3 / 3
Distinctiveness Conflict Risk	The niche is sharply defined by Novu-specific concepts (Bridge Endpoint, Step Controls, HMAC, React/Vue/Svelte Email), making it unlikely to trigger for unrelated notification skills.	3 / 3
	Total	12 / 12 Passed

Validation

81%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 13 / 16 Passed

Validation for skill structure

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (831 lines); consider splitting into references/ and linking	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning
relative_links	Relative link issues: 5 suspicious	Warning

	Total	13 / 16 Passed

Repository: novuhq/novu
Path: docs/.mintlify/skills/framework-integration/SKILL.md
Commit: 0da9e0a

Reviewed: about 13 hours ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.