Refresh n8n Docs Cache

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

Adds significant information beyond annotations: parallel fetch with concurrency limit, file count, output JSON shape, and semantics of 'fetched'. Annotations already mark idempotent and non-destructive; description reinforces and extends.

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

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

Four sentences with critical info front-loaded (purpose, then details about size, concurrency, output). No extraneous words.

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

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

For a parameterless refresh tool with output schema and annotations, description covers purpose, scale (1500 files), parallelism (10 concurrent), return format, and edge case (errors list). Fully adequate.

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

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

No parameters defined; schema coverage is 100% trivially. Description does not need to clarify parameters; baseline for 0-param tools is 4.

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

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

Description starts with clear verb 'Re-fetch' and specific resource 'n8n markdown files from GitHub' and action 'overwrite the cache'. Distinct from sibling tools like get_doc or search_docs.

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

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

Explicitly states two use cases: documentation outdated or after n8n release. Does not provide negative guidance (when not to use), but context signals show no parameters so use is straightforward.

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