n8n_audit_instance

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

Annotations already indicate read-only, idempotent, non-destructive. Description adds value by explaining it returns a markdown report with remediation steps and combines built-in API with deep scanning, but does not reveal further behavioral traits like rate limits or authorization needs.

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?

Three well-structured sentences: purpose, what it combines, and output format with remediation. No redundant information; every sentence adds value.

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?

Given no output schema, description explains return format (markdown report with remediation steps) and mentions how to use results with sibling tools. Covers all key aspects for an audit tool with comprehensive annotations.

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?

Schema coverage is 100% with descriptions for each parameter. Description reinforces the distinction between built-in categories and custom checks, adding meaning beyond enum values by explaining they correspond to 'built-in audit API' and 'deep workflow scanning' respectively.

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?

Clearly specifies it's a security audit tool for n8n instance. Distinguishes from siblings by combining built-in audit API categories with deep workflow scanning, and mentions output as actionable markdown report with remediation steps referencing sibling tools.

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?

States what the tool does and what it checks, implying use for security auditing. References sibling tools for remediation but lacks explicit when-to-use vs alternatives or exclusion criteria.

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