n8n-node-creation

name	n8n-node-creation
description	Quick index for n8n custom node creation docs. USE FOR: finding the right page across overview, planning, build, test, and deploy stages. TRIGGERS: 'n8n creating nodes', 'plan node type', 'declarative vs programmatic', 'node file structure', 'node linter', 'deploy community node'. DO NOT USE FOR: copying full docs content; provide concise pointers only.

n8n Node Creation Docs Index

Use this skill to route work to the correct n8n documentation page quickly.

When To Use

• You need a fast map of the n8n node-creation lifecycle.
• You want links with short descriptions instead of long doc extracts.
• You are deciding what to read next while building a community or private node.

Lifecycle Index

1) Overview

• Creating nodes: Entry point for the full lifecycle and prerequisites.

2) Plan

• Plan a node: Design decisions before implementation.
• Choose a node type: Pick the right node category and behavior model.
• Choose a node building style: Decide between declarative and programmatic approaches.
• Node UI design: UX and parameter design guidance.

3) Build

• Build your node: Build-phase hub with tutorials and references.
• Set up your development environment: Local tooling and workspace setup.
• Using the n8n-node tool: Scaffold and helper CLI for node development.
• Tutorial: Build a declarative-style node: Walkthrough for config-driven nodes.
• Tutorial: Build a programmatic-style node: Walkthrough for code-first nodes.

Build Reference

• Reference hub: Central reference for implementation details.
• Node UI elements: Available UI controls and patterns.
• Code standards: Style and maintainability expectations.
• Error handling: Recommended error patterns and messaging.
• Versioning: Safe upgrades and backward compatibility.
• Node file structure: Folder and file layout for node packages.
• Node base files: Core node definition files.
• Codex files: Metadata files used for discoverability and docs.
• Credentials files: Credential type definitions and auth wiring.
• HTTP request helpers: Helpers for robust API calls.
• Item linking (paired items): Preserve item lineage through execution.
• UX guidelines: Consistency and usability expectations.
• Verification guidelines: Requirements for verified node submission quality.

4) Test

• Test your node: Testing workflow for local validation.
• Run your node locally: Execute and inspect behavior in development.
• Node linter: Detect quality and compatibility issues early.
• Troubleshooting node development: Common failure modes and fixes.

5) Deploy

• Deploy your node: Distribution and release options.
• Submit community nodes: Publish and optionally seek verification.
• Install private nodes: Internal/private distribution path.

Suggested Reading Path

1. Overview
2. Plan (type, style, UI)
3. Build (tutorial + reference)
4. Test (local run + linter)
5. Deploy (community or private)