n8n_audit_instance

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true. The description adds further transparency by detailing the audit process (built-in API + deep scanning) and output (markdown report with remediation steps), with 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.

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

The description is a concise three-sentence paragraph that front-loads the purpose and efficiently covers all key aspects without superfluous information.

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 the tool's complexity (multiple audit categories and custom scans) and the absence of an output schema, the description fully explains inputs, process, and output (markdown report), making it self-contained and actionable.

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%, providing descriptions for all 4 parameters. The description adds context beyond the schema, such as mentioning '50+ regex patterns' for custom checks, which enriches understanding. However, since schema descriptions are already thorough, the incremental value is moderate.

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?

The description clearly defines the tool's purpose with a specific verb-resource combination: 'Security audit of n8n instance.' It distinguishes itself from sibling tools by outlining unique capabilities like deep workflow scanning and remediation steps, and mentions specific categories and checks.

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?

The description implicitly suggests when to use this tool (for security audits) and references related tools (n8n_manage_credentials, n8n_update_partial_workflow) for remediation, but lacks explicit guidance on when not to use it compared to similar siblings like n8n_health_check.

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