Skip to main content
Glama

Get n8n Doc

get_doc
Read-onlyIdempotent

Retrieve any n8n documentation page as markdown by providing the doc slug, URL, or a partial path for fuzzy matching.

Instructions

Read a single n8n documentation page as markdown.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesDoc slug. Friendly forms accepted: - "integrations/builtin/core-nodes/n8n-nodes-base.code" - "integrations/builtin/core-nodes/n8n-nodes-base.code.md" - "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.code" - "n8n-nodes-base.code" (partial — will fuzzy-match)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds value by specifying output format (markdown) and input flexibility (multiple path forms). No contradictions.

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

Conciseness5/5

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

Single sentence: 'Read a single n8n documentation page as markdown.' Concise, front-loaded, and every word adds value. No redundancy.

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 simple read-only tool with high schema coverage, an output schema exists, and annotations cover safety. The description provides the output format. Could mention error handling for invalid paths, but not critical.

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 schema already documents the path parameter thoroughly. The tool description does not add additional parameter-level information, so it provides no extra value beyond the schema.

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

Purpose5/5

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

Description clearly states 'Read a single n8n documentation page as markdown.' The verb 'Read' and resource 'n8n documentation page' are specific, and the mention of markdown distinguishes it from siblings like get_template or list_docs.

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?

Description implies use for reading a single doc page but provides no explicit guidance on when to use this tool versus alternatives (e.g., list_docs, search_docs). No exclusions or context for sibling differentiation.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/okdk7788/docs-n8n-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server