Skip to content

Developing Nodes

This section provides comprehensive documentation for developers building custom nodes for Griptape Nodes.

For AI Assistants & Coding Agents

All documentation in this section is available as post-processed markdown for AI coding assistants. The site exposes a full machine-readable surface; see For Agents for the index.

Usage: Point your AI assistant to these URLs with instructions like: "Read this node development guide: [URL] and help me build a custom node"

Getting Started

If you're new to developing nodes, start with the Getting Started Guide. This guide provides a beginner-friendly introduction to the node development ecosystem and walks you through building your first node.

Comprehensive Reference

For detailed technical information, see the Comprehensive Node Development Guide. This exhaustive reference covers:

  • Node base classes (DataNode, ControlNode, StartNode, EndNode, etc.)
  • Parameters, traits, containers, and lifecycle callbacks
  • Async patterns (AsyncResult)
  • Advanced UI/UX and error-handling guidance
  • Creating and distributing node libraries
  • Custom widget components
  • Production best practices

Practical Examples

  • Example Control Node - A complete working example demonstrating best practices for building control nodes

Start from the Template Repository

The fastest way to a production-ready node library is the official template repository:

Griptape Nodes Library Template (readme)

It provides the necessary boilerplate, testing framework, and documentation patterns. The workflow:

  1. Use the template repository - Create your own repository from the GitHub template
  2. Set up your environment - Clone the repo to your Griptape Nodes workspace directory
  3. Configure your library - Rename directories and update package information in pyproject.toml
  4. Create your nodes - Define node classes (either ControlNode or DataNode) with appropriate parameters
  5. Implement your logic - Code the required process() method and any additional functionality
  6. Configure library metadata - Set up your library.json file with nodes and category information
  7. Register with the engine - Add your library to Griptape Nodes through the settings interface
  8. Test and use - Create flows using your custom nodes in the Griptape Nodes interface

To understand how to design your nodes, explore the patterns used in the standard library: node reference.

Documentation Structure

  1. Getting Started - Your first node and essential concepts
  2. Comprehensive Guide - Complete technical reference
  3. Example Code - Practical implementation patterns