Agent skill · software engineering · n8n-io
n8n:conventions
Quick reference for n8n patterns. Full docs /AGENTS.md
Why this skill is useful
Provides specific TypeScript patterns and error handling practices that the AI wouldn't reliably generate on its own.
What it needs
About 2k tokens when loaded. Last updated 2026-08-07. 199,638 stars on the source repository.
What this skill does
n8n Quick Reference 📚 Full Documentation: General: /AGENTS.md - Architecture, commands, workflows Frontend: /packages/frontend/AGENTS.md - CSS variables, timing Use this skill when you need quick reminders on critical patterns. Critical Rules (Must Follow) Technical writing (comments, PRs, issues, docs): Write in ASD-STE100 Simplified Technical English: short sentences, the active voice, one instruction for each sentence TypeScript: Never any → use unknown Prefer satisfies over as (except tests) Shared types in @n8n/api-types Error Handling: Frontend: Vue 3 Composition API (<script setup lang="ts">) CSS variables (never hardcode px) - see /packages/frontend/AGENTS.md All text via i18n ($t('key')) data-testid for E2E (single value, no spaces) Backend: Controller → Service → Repository Dependency injection via @n8n/di Config via @n8n/config Zod schemas for validation Pagination args: use offset + limit in controllers and services; translate to TypeORM skip/take only inside repositories Testing: Vitest (unit), Playwright (E2E) Mock external dependencies Work from package directory: pushd packages/cli && pnpm test Database: SQLite/PostgreSQL only (app DB) Exception: DB nodes (MySQL Node, etc.) can use DB-specific features GitHub Workflows: Every workflow declares a least-privilege top-level permissions: block (usually contents: read); jobs needing more override at job level Commands: Secrets: pnpm command lines may be recorded verbatim (opt-in dev metrics) — pass sensitive values via env vars, never inline on the command line. Key Packages Package Purpose --------- --------- packages/cli Backend API packages/frontend/editor-ui Vue 3 frontend shell packages/modules/<name>/frontend Frontend feature modules. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills n8n-io/conventions