Skip to main content
Glama

node_get_documentation

Read-only

Read only. Returns the reference documentation for the step (node) types you name: their inputs, outputs, parameters and an example. It does not run, add or change any step.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "nodeTypes": "<nodeTypes>"
    },
    "name": "node_get_documentation"
  }
}

Input Schema

NameRequiredDescriptionDefault
nodeTypesYesNode types, optionally with @version (e.g., ["if_else@2.0.0", "input"])

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so 'Read only' and 'does not run, add or change any step' largely restate structured data. The genuinely additive part is disclosing the return content (inputs, outputs, parameters, example), which matters since there is no output schema, but nothing is said about unknown node types or version-mismatch behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with the safety property front-loaded and the response contents second; there is no padding. The opening 'Read only' is slightly redundant with the annotations, keeping it just below the top mark.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter, non-destructive lookup with full schema coverage and no output schema, the description covers what the tool returns and that it has no side effects. The only meaningful gap is the absence of any sibling routing, which is minor at this complexity level.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single nodeTypes parameter already documents the '@version' suffix syntax, so the schema carries the semantics. The phrase 'the step (node) types you name' only confirms plurality and the step/node synonym, adding little beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource ('Returns the reference documentation for the step (node) types you name') and enumerates the content returned (inputs, outputs, parameters, example). It stops short of naming the closest siblings such as node_list_types or workflow_get_node, so an agent must infer the boundary rather than being told it.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Read only' and 'It does not run, add or change any step' implicitly rule out the execution and mutation siblings, which is real scoping guidance. However, no alternative is named explicitly and no trigger condition is given (e.g., when to use this versus node_list_types or node_list_configs), so the routing is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.