generate-audit

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool generates an audit but doesn't describe what the output looks like (e.g., report format, data included), whether it's a read-only operation, if it requires specific permissions, or any side effects (e.g., logging, notifications). This leaves significant gaps for an agent to understand how to use it effectively.

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 single, efficient sentence that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded, making it easy to parse quickly. Every part of the sentence contributes to understanding the tool's function.

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 complexity of a security audit tool with 3 parameters, 0% schema coverage, no annotations, and no output schema, the description is incomplete. It doesn't address key aspects like what the audit checks, how results are returned, or the meaning of parameters. For a tool that likely produces detailed security insights, this minimal description leaves too much undefined for effective use.

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 description coverage is 0%, meaning none of the three parameters (categories, clientId, daysAbandonedWorkflow) are documented in the schema. The description adds no information about these parameters—it doesn't explain what 'categories' includes, what 'clientId' refers to, or how 'daysAbandonedWorkflow' affects the audit. With low coverage, the description fails to compensate, leaving parameters largely unexplained.

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 states the action ('generate') and the resource ('security audit for your n8n instance'), providing a specific purpose. It distinguishes itself from sibling tools which focus on CRUD operations for workflows, credentials, users, etc., rather than security auditing. However, it doesn't explicitly mention what the audit entails or its scope beyond 'security'.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, frequency, or typical use cases (e.g., compliance checks, security reviews). With many sibling tools for managing n8n resources, there's no indication of how this tool fits into broader workflows or when it should be invoked.

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