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 a security audit but does not explain what the audit does—e.g., whether it scans for vulnerabilities, logs activity, or produces a report. Critical details like permission requirements, rate limits, or whether it's a read-only or mutative operation are missing, leaving significant gaps in understanding its behavior.

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 is front-loaded with the main action. It avoids unnecessary words and gets straight to the point. However, it is overly concise given the tool's complexity, as it omits important details that would help an agent use it effectively, slightly reducing its utility.

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 (generating a security audit with 3 parameters), lack of annotations, and no output schema, the description is incomplete. It does not cover what the audit entails, how parameters influence it, or what the output looks like. For a tool that likely produces detailed results, this leaves too much undefined, making it inadequate for proper agent usage.

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?

The input schema has 3 parameters with 0% description coverage, so the schema provides no semantic information. The description does not mention any parameters, failing to compensate for this gap. For example, it does not explain what 'clientId', 'daysAbandonedWorkflow', or 'categories' mean or how they affect the audit, leaving parameters undocumented and unclear in purpose.

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 states the tool's purpose as 'Generate a security audit for your n8n instance,' which is clear but vague. It specifies the verb 'generate' and resource 'security audit,' but lacks details on what the audit entails or how it differs from other tools. It distinguishes from siblings like 'activate-workflow' or 'create-credential' by focusing on security, but the scope remains broad without specifics.

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 does not mention prerequisites, timing, or exclusions, such as whether it requires specific permissions or should be run periodically. With many sibling tools for managing workflows, credentials, and users, there is no indication of when a security audit is appropriate compared to other operations.

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