Skip to main content

​
Overview

Unified node information tool with progressive detail levels and multiple operation modes. Get node schemas, readable documentation, search for specific properties, or check version history. Performance: Instant (< 10ms) for minimal/standard, moderate for full

​
Parameters

​
nodeType
string
required
Full node type with prefix.Examples:
  • "nodes-base.httpRequest"
  • "nodes-base.slack"
  • "nodes-langchain.agent"
​
detail
string
default:"standard"
Information detail level (applies to mode="info" only).
​
mode
string
default:"info"
Operation mode.
​
includeTypeInfo
boolean
default:false
Include type structure metadata (type category, JS type, validation rules).Only applies to mode="info". Adds ~80-120 tokens per property.
​
includeExamples
boolean
default:false
Include real-world configuration examples from templates.Only applies to mode="info" with detail="standard". Adds ~200-400 tokens per example.
​
propertyQuery
string
Search term to find properties (for mode="search_properties")Examples:
  • "auth" - Find authentication properties
  • "header" - Find header-related properties
  • "body" - Find body configuration properties
​
maxPropertyResults
number
default:20
Maximum results for mode="search_properties"
​
fromVersion
string
Source version for compare/breaking/migrations modes.Example: "1.0", "2.5"
​
toVersion
string
Target version for compare mode. Defaults to latest if omitted.Example: "2.0", "3.1"

​
Response

Response structure depends on the mode parameter:

​
mode=“info”

​
nodeType
string
Full node type identifier
​
workflowNodeType
string
Node type to use in workflow JSON (may differ from nodeType for versioned nodes)
​
displayName
string
Human-readable node name
​
description
string
Node description
​
category
string
Node category
​
properties
array
Node properties (varies by detail level)
​
operations
array
Available operations (for resource-based nodes)
​
credentials
object
Required credential types
​
versionInfo
object
Version information

​
mode=“docs”

​
documentation
string
Markdown-formatted documentation with examples and patterns

​
mode=“search_properties”

​
matches
array
Array of matching property paths with descriptions

​
mode=“versions”

​
versions
array
List of all available versions with metadata
​
latestVersion
string
Latest available version
​
hasBreakingChanges
boolean
Whether any version has breaking changes

​
Examples

{
  "nodeType": "nodes-base.httpRequest"
}

​
Response Example (Standard Detail)

{
  "nodeType": "nodes-base.webhook",
  "workflowNodeType": "n8n-nodes-base.webhook",
  "displayName": "Webhook",
  "description": "Starts the workflow when a webhook is called",
  "category": "Core Nodes",
  "properties": [
    {
      "name": "httpMethod",
      "displayName": "HTTP Method",
      "type": "options",
      "required": true,
      "default": "GET",
      "options": [
        {"name": "GET", "value": "GET"},
        {"name": "POST", "value": "POST"},
        {"name": "PUT", "value": "PUT"},
        {"name": "DELETE", "value": "DELETE"}
      ]
    },
    {
      "name": "path",
      "displayName": "Path",
      "type": "string",
      "required": true,
      "default": "",
      "description": "The path for the webhook URL"
    }
  ],
  "versionInfo": {
    "currentVersion": "1.0",
    "totalVersions": 1,
    "hasVersionHistory": false
  }
}

​
Use Cases

  • Configure nodes for workflow building: Use detail="standard" to get essential properties
  • Find specific configuration options: Use mode="search_properties" to search within a node
  • Get human-readable documentation: Use mode="docs" for markdown documentation
  • Check for breaking changes: Use mode="breaking" before version upgrades
  • Understand complex types: Use includeTypeInfo=true for filter, resourceMapper nodes

​
Best Practices

Standard detail covers 95% of use cases and provides all essential properties.
// Recommended for AI agents
{"nodeType": "nodes-base.httpRequest"}
Full detail returns large responses (~100KB). Only use when standard is missing required properties.
// Only if standard doesn't have what you need
{"nodeType": "nodes-base.googleSheets", "detail": "full"}
When explaining nodes to users, use docs mode for readable markdown.
{"nodeType": "nodes-base.webhook", "mode": "docs"}
Before configuring versioned nodes, check version history to understand changes.
{"nodeType": "nodes-base.httpRequest", "mode": "versions"}

​
Common Pitfalls

Full detail returns large responses: detail="full" can return ~100KB responses. Use sparingly to avoid performance issues.
Node type must include prefix: Use "nodes-base.httpRequest" not just "httpRequest".
includeExamples only works with standard: includeExamples=true only applies to mode="info" with detail="standard".
Version modes require multiple versions: Version comparison modes only work for nodes with multiple versions in the database.

​
Token Cost by Detail Level

Detail LevelToken CostUse Case
minimal~200 tokensQuick metadata check
standard~1000-2000 tokensConfiguration (recommended)
full~3000-8000 tokensComplete schema
+includeTypeInfo+80-120 per propertyComplex type validation
+includeExamples+200-400 per exampleReal-world examples
Version modes~400-1200 tokensVersion comparison

search_nodes

Search for nodes first

validate_node

Validate configurations

validate_workflow

Validate complete workflows

Build docs developers (and LLMs) love

Get started for freeTalk to us