# Documentation Documentation for the Griptape Nodes engine: scripting (retained mode), the project system, custom node development, the built-in node reference, and the engine MCP surface. Use these files to ground an agent in the engine's actual API rather than scraping rendered HTML or fetching unrenderered raw markdown from `main`. ## Overview - [Overview](https://docs.griptapenodes.com/index.md): Top-level introduction to Griptape Nodes - [For Agents](https://docs.griptapenodes.com/for_agents/index.md): Hosted machine-readable docs surface (this page) - [FAQ](https://docs.griptapenodes.com/faq/index.md): Frequently asked questions - [Glossary](https://docs.griptapenodes.com/glossary/index.md): Terms and definitions used throughout the docs - [Installation](https://docs.griptapenodes.com/installation/index.md): Install the engine ## Configuration and CLI - [Engine Configuration](https://docs.griptapenodes.com/configuration/index.md): Engine configuration (workspace, secrets, libraries) - [Command Line Interface](https://docs.griptapenodes.com/command_line_interface/index.md): gtn CLI reference ## Scripting (retained mode) - [Scripting](https://docs.griptapenodes.com/retained_mode/index.md): Engine scripting API for building and running workflows ## Project system - [Overview](https://docs.griptapenodes.com/projects/index.md): Project system overview - [Workspace](https://docs.griptapenodes.com/projects/workspace/index.md): Workspace concepts - [Projects](https://docs.griptapenodes.com/projects/projects/index.md): Projects - [Macros](https://docs.griptapenodes.com/projects/macros/index.md): Macros - [Directories](https://docs.griptapenodes.com/projects/directories/index.md): Directories - [Situations](https://docs.griptapenodes.com/projects/situations/index.md): Situations - [Environment & Builtin Variables](https://docs.griptapenodes.com/projects/environment/index.md): Environment and built-in variables - [File Extension Directories](https://docs.griptapenodes.com/projects/file_extension_directories/index.md): File extension directories - [Customization Guide](https://docs.griptapenodes.com/projects/customization/index.md): Customization guide ## Custom nodes and scripts - [Overview](https://docs.griptapenodes.com/developing_nodes/index.md): Developing custom nodes overview - [Getting Started](https://docs.griptapenodes.com/developing_nodes/getting_started/index.md): Beginner-friendly intro to node development - [Comprehensive Guide](https://docs.griptapenodes.com/developing_nodes/comprehensive_guide/index.md): Exhaustive node development reference - [Making Custom Nodes](https://docs.griptapenodes.com/how_to/making_custom_nodes/index.md): Quick start template for building a custom node - [Making Custom Scripts](https://docs.griptapenodes.com/how_to/making_custom_scripts/index.md): Build custom node execution scripts ## Beginner tutorial (FTUE) - [Tutorial Overview](https://docs.griptapenodes.com/ftue/FTUE/index.md): Tutorial overview - [1. Getting Started](https://docs.griptapenodes.com/ftue/00_tour/FTUE_00_tour/index.md) - [2. Prompt an Image](https://docs.griptapenodes.com/ftue/01_prompt_an_image/FTUE_01_prompt_an_image/index.md) - [3. Coordinating Agents](https://docs.griptapenodes.com/ftue/02_coordinating_agents/FTUE_02_coordinating_agents/index.md) - [4. Compare Prompts](https://docs.griptapenodes.com/ftue/03_compare_prompts/FTUE_03_compare_prompts/index.md) - [5. Build a Photography Team](https://docs.griptapenodes.com/ftue/04_photography_team/FTUE_04_photography_team/index.md) ## External services - [OpenAI](https://docs.griptapenodes.com/how_to/keys/openai/index.md) - [Grok](https://docs.griptapenodes.com/how_to/keys/grok/index.md) - [Hugging Face](https://docs.griptapenodes.com/how_to/installs/hugging_face/index.md) ## MCP integration - [Overview](https://docs.griptapenodes.com/how_to/mcp/index.md): MCP integration overview - [Getting Started](https://docs.griptapenodes.com/how_to/mcp/getting_started/index.md) - [Using MCPTask with Agents](https://docs.griptapenodes.com/how_to/mcp/mcp_task_agents/index.md) - [Local Models with Agents](https://docs.griptapenodes.com/how_to/mcp/advanced_local_models/index.md) - [Local Process (stdio)](https://docs.griptapenodes.com/how_to/mcp/connection_types/stdio/index.md) - [Server-Sent Events (SSE)](https://docs.griptapenodes.com/how_to/mcp/connection_types/sse/index.md) - [Streamable HTTP](https://docs.griptapenodes.com/how_to/mcp/connection_types/streamable_http/index.md) - [WebSocket](https://docs.griptapenodes.com/how_to/mcp/connection_types/websocket/index.md) - [MCP Server Rules](https://docs.griptapenodes.com/how_to/mcp/rules/index.md) - [Overview](https://docs.griptapenodes.com/how_to/mcp/servers/index.md) - [Blender](https://docs.griptapenodes.com/how_to/mcp/servers/blender/index.md) - [Maya](https://docs.griptapenodes.com/how_to/mcp/servers/maya/index.md) - [Exa](https://docs.griptapenodes.com/how_to/mcp/servers/exa/index.md) - [Fetch](https://docs.griptapenodes.com/how_to/mcp/servers/fetch/index.md) - [Filesystem](https://docs.griptapenodes.com/how_to/mcp/servers/filesystem/index.md) - [Time](https://docs.griptapenodes.com/how_to/mcp/servers/time/index.md) ## Agent skills - [Griptape Nodes Workflow Construction Guide](https://docs.griptapenodes.com/skills/griptape-nodes-workflows/SKILL/index.md): Build, run, and inspect workflows through the engine's MCP server ## Node reference - [Overview](https://docs.griptapenodes.com/nodes/overview/index.md) - [Diffusion Pipelines](https://docs.griptapenodes.com/nodes/advanced_media_library/diffusion_pipelines/index.md) - [YOLOv8 Face Detection](https://docs.griptapenodes.com/nodes/advanced_media_library/yolov8_face_detection/index.md) - [Agent](https://docs.griptapenodes.com/nodes/agents/create_agent/index.md) - [Load Audio](https://docs.griptapenodes.com/nodes/audio/load_audio/index.md) - [Microphone](https://docs.griptapenodes.com/nodes/audio/microphone/index.md) - [Transcribe Audio](https://docs.griptapenodes.com/nodes/audio/transcribe_audio/index.md) - [Anthropic Prompt](https://docs.griptapenodes.com/nodes/config/anthropic_prompt_driver/index.md) - [Cohere Prompt](https://docs.griptapenodes.com/nodes/config/cohere_prompt_driver/index.md) - [Griptape Cloud Image](https://docs.griptapenodes.com/nodes/config/griptape_cloud_image_driver/index.md) - [Griptape Cloud Prompt](https://docs.griptapenodes.com/nodes/config/griptape_cloud_prompt_driver/index.md) - [Grok Image](https://docs.griptapenodes.com/nodes/config/grok_image_driver/index.md) - [Grok Prompt](https://docs.griptapenodes.com/nodes/config/grok_prompt_driver/index.md) - [Groq Prompt](https://docs.griptapenodes.com/nodes/config/groq_prompt_driver/index.md) - [OpenAI Image](https://docs.griptapenodes.com/nodes/config/openai_image_driver/index.md) - [OpenAI Prompt](https://docs.griptapenodes.com/nodes/config/openai_prompt_driver/index.md) - [To JSON](https://docs.griptapenodes.com/nodes/convert/to_json/index.md) - [Dict](https://docs.griptapenodes.com/nodes/dict/create_dict/index.md) - [Display Dict](https://docs.griptapenodes.com/nodes/dict/display_dict/index.md) - [Key Value Pair](https://docs.griptapenodes.com/nodes/dict/key_value_pair/index.md) - [Merge Key Value Pairs](https://docs.griptapenodes.com/nodes/dict/merge_key_value_pair/index.md) - [End Flow](https://docs.griptapenodes.com/nodes/execution/end_flow/index.md) - [Reroute](https://docs.griptapenodes.com/nodes/execution/reroute/index.md) - [Start Flow](https://docs.griptapenodes.com/nodes/execution/start_flow/index.md) - [Add Bounding Boxes](https://docs.griptapenodes.com/nodes/image/add_bounding_boxes/index.md) - [Add Text to Existing Image](https://docs.griptapenodes.com/nodes/image/add_text_to_existing_image/index.md) - [Adjust Image EQ](https://docs.griptapenodes.com/nodes/image/adjust_image_eq/index.md) - [Adjust Image Levels](https://docs.griptapenodes.com/nodes/image/adjust_image_levels/index.md) - [Apply Mask](https://docs.griptapenodes.com/nodes/image/apply_mask/index.md) - [Bloom Effect](https://docs.griptapenodes.com/nodes/image/bloom_effect/index.md) - [Color Match](https://docs.griptapenodes.com/nodes/image/color_match/index.md) - [Combine Masks](https://docs.griptapenodes.com/nodes/image/combine_masks/index.md) - [Compare Images](https://docs.griptapenodes.com/nodes/image/compare_images/index.md) - [Create Color Bars](https://docs.griptapenodes.com/nodes/image/create_color_bars/index.md) - [Generate Image](https://docs.griptapenodes.com/nodes/image/create_image/index.md) - [Crop Image](https://docs.griptapenodes.com/nodes/image/crop_image/index.md) - [Describe Image](https://docs.griptapenodes.com/nodes/image/describe_image/index.md) - [Display Channel](https://docs.griptapenodes.com/nodes/image/display_channel/index.md) - [Display Image](https://docs.griptapenodes.com/nodes/image/display_image/index.md) - [Display Image Grid](https://docs.griptapenodes.com/nodes/image/display_image_grid/index.md) - [Display Mask](https://docs.griptapenodes.com/nodes/image/display_mask/index.md) - [Extend Canvas](https://docs.griptapenodes.com/nodes/image/extend_canvas/index.md) - [Extract Key Colors](https://docs.griptapenodes.com/nodes/image/extract_key_colors/index.md) - [Flip Image](https://docs.griptapenodes.com/nodes/image/flip_image/index.md) - [Gaussian Edge Fade](https://docs.griptapenodes.com/nodes/image/gaussian_edge_fade/index.md) - [Image Bash](https://docs.griptapenodes.com/nodes/image/image_bash/index.md) - [Image Blend Compositor](https://docs.griptapenodes.com/nodes/image/image_blend_compositor/index.md) - [Image Grid Splitter](https://docs.griptapenodes.com/nodes/image/image_grid_splitter/index.md) - [Invert Image](https://docs.griptapenodes.com/nodes/image/invert_image/index.md) - [Invert Mask](https://docs.griptapenodes.com/nodes/image/invert_mask/index.md) - [Load Image](https://docs.griptapenodes.com/nodes/image/load_image/index.md) - [Merge Images](https://docs.griptapenodes.com/nodes/image/merge_images/index.md) - [Paint Mask](https://docs.griptapenodes.com/nodes/image/paint_mask/index.md) - [Rescale Image](https://docs.griptapenodes.com/nodes/image/rescale_image/index.md) - [Save Image](https://docs.griptapenodes.com/nodes/image/save_image/index.md) - [Webcam](https://docs.griptapenodes.com/nodes/image/webcam/index.md) - [Display JSON](https://docs.griptapenodes.com/nodes/json/display_json/index.md) - [JSON Extract Value](https://docs.griptapenodes.com/nodes/json/json_extract_value/index.md) - [JSON Find](https://docs.griptapenodes.com/nodes/json/json_find/index.md) - [JSON Input](https://docs.griptapenodes.com/nodes/json/json_input/index.md) - [JSON Replace](https://docs.griptapenodes.com/nodes/json/json_replace/index.md) - [Add To List](https://docs.griptapenodes.com/nodes/lists/add_to_list/index.md) - [Combine Lists](https://docs.griptapenodes.com/nodes/lists/combine_lists/index.md) - [Create Bool List](https://docs.griptapenodes.com/nodes/lists/create_bool_list/index.md) - [Create Float List](https://docs.griptapenodes.com/nodes/lists/create_float_list/index.md) - [Create Int List](https://docs.griptapenodes.com/nodes/lists/create_int_list/index.md) - [Create List](https://docs.griptapenodes.com/nodes/lists/create_list/index.md) - [Create Text List](https://docs.griptapenodes.com/nodes/lists/create_text_list/index.md) - [Display List](https://docs.griptapenodes.com/nodes/lists/display_list/index.md) - [Get From List](https://docs.griptapenodes.com/nodes/lists/get_from_list/index.md) - [Get Index Of Item](https://docs.griptapenodes.com/nodes/lists/get_index_of_item/index.md) - [Get List Contains Item](https://docs.griptapenodes.com/nodes/lists/get_list_contains_item/index.md) - [Get List Is Empty](https://docs.griptapenodes.com/nodes/lists/get_list_is_empty/index.md) - [Get List Length](https://docs.griptapenodes.com/nodes/lists/get_list_length/index.md) - [Remove From List](https://docs.griptapenodes.com/nodes/lists/remove_from_list/index.md) - [Replace In List](https://docs.griptapenodes.com/nodes/lists/replace_in_list/index.md) - [Select From List](https://docs.griptapenodes.com/nodes/lists/select_from_list/index.md) - [Split List](https://docs.griptapenodes.com/nodes/lists/split_list/index.md) - [Askulator](https://docs.griptapenodes.com/nodes/number/askulator/index.md) - [Bool Input](https://docs.griptapenodes.com/nodes/number/create_bool/index.md) - [Float Input](https://docs.griptapenodes.com/nodes/number/create_float/index.md) - [Int Input](https://docs.griptapenodes.com/nodes/number/create_int/index.md) - [Display Float](https://docs.griptapenodes.com/nodes/number/display_float/index.md) - [Display Int](https://docs.griptapenodes.com/nodes/number/display_int/index.md) - [Math Operations](https://docs.griptapenodes.com/nodes/number/math/index.md) - [Ruleset](https://docs.griptapenodes.com/nodes/rules/create_ruleset/index.md) - [Ruleset List](https://docs.griptapenodes.com/nodes/rules/ruleset_list/index.md) - [Text Input](https://docs.griptapenodes.com/nodes/text/create_multiline_text/index.md) - [Date and Time](https://docs.griptapenodes.com/nodes/text/date_and_time/index.md) - [Display Text](https://docs.griptapenodes.com/nodes/text/display_text/index.md) - [Evaluate Text Result](https://docs.griptapenodes.com/nodes/text/evaluate_text_result/index.md) - [Load Text](https://docs.griptapenodes.com/nodes/text/load_text/index.md) - [Merge Texts](https://docs.griptapenodes.com/nodes/text/merge_texts/index.md) - [Random Text](https://docs.griptapenodes.com/nodes/text/random_text/index.md) - [Save Text](https://docs.griptapenodes.com/nodes/text/save_text/index.md) - [Scrape Web](https://docs.griptapenodes.com/nodes/text/scrape_web/index.md) - [Search Replace Text](https://docs.griptapenodes.com/nodes/text/search_replace_text/index.md) - [Search Web](https://docs.griptapenodes.com/nodes/text/search_web/index.md) - [Summarize Text](https://docs.griptapenodes.com/nodes/text/summarize_text/index.md) - [Load 3D](https://docs.griptapenodes.com/nodes/three_d/load_gltf/index.md) - [Calculator](https://docs.griptapenodes.com/nodes/tools/calculator_tool/index.md) - [Date Time](https://docs.griptapenodes.com/nodes/tools/date_time_tool/index.md) - [File Manager](https://docs.griptapenodes.com/nodes/tools/file_manager_tool/index.md) - [Info Retriever](https://docs.griptapenodes.com/nodes/tools/rag_tool/index.md) - [Tool List](https://docs.griptapenodes.com/nodes/tools/tool_list/index.md) - [Web Scraper](https://docs.griptapenodes.com/nodes/tools/web_scraper_tool/index.md) - [Web Search](https://docs.griptapenodes.com/nodes/tools/web_search_tool/index.md) - [Note](https://docs.griptapenodes.com/nodes/utils/note/index.md) - [Add Color Curves](https://docs.griptapenodes.com/nodes/video/add_color_curves/index.md) - [Add Film Grain](https://docs.griptapenodes.com/nodes/video/add_film_grain/index.md) - [Add Overlay](https://docs.griptapenodes.com/nodes/video/add_overlay/index.md) - [Add RGB Shift](https://docs.griptapenodes.com/nodes/video/add_rgb_shift/index.md) - [Add Vignette](https://docs.griptapenodes.com/nodes/video/add_vignette/index.md) - [Adjust Mask Size](https://docs.griptapenodes.com/nodes/video/adjust_mask_size/index.md) - [Adjust Video EQ](https://docs.griptapenodes.com/nodes/video/adjust_video_eq/index.md) - [Change Speed](https://docs.griptapenodes.com/nodes/video/change_speed/index.md) - [Combine Masks Video](https://docs.griptapenodes.com/nodes/video/combine_masks_video/index.md) - [Concatenate Videos](https://docs.griptapenodes.com/nodes/video/concatenate_videos/index.md) - [Display Video](https://docs.griptapenodes.com/nodes/video/display_video/index.md) - [Extract Audio](https://docs.griptapenodes.com/nodes/video/extract_audio/index.md) - [Extract Last Frame](https://docs.griptapenodes.com/nodes/video/extract_last_frame/index.md) - [Flip Video](https://docs.griptapenodes.com/nodes/video/flip_video/index.md) - [Hold Video Frames](https://docs.griptapenodes.com/nodes/video/hold_video_frames/index.md) - [Load Video](https://docs.griptapenodes.com/nodes/video/load_video/index.md) - [Resize Video](https://docs.griptapenodes.com/nodes/video/resize_video/index.md) - [Reverse Video](https://docs.griptapenodes.com/nodes/video/reverse_video/index.md) - [Save Video](https://docs.griptapenodes.com/nodes/video/save_video/index.md) - [Split Video](https://docs.griptapenodes.com/nodes/video/split_video/index.md) - [Video Color Match](https://docs.griptapenodes.com/nodes/video/video_color_match/index.md)