generate_environment_report

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

With no annotations, the description carries the full burden. It discloses that the tool returns Markdown with an Excalidraw diagram, but does not mention whether the operation is read-only, potential performance impacts (due to comprehensive scope), or permission requirements. The output format is clear, but behavioral traits are insufficiently covered.

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 two sentences with no wasted words. The first sentence front-loads the purpose, and the second adds output format. Every sentence earns its place.

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, the description explains the return format (Markdown + diagram) adequately. However, it lacks information about potential report size, execution time, or prerequisites. Context around when to use this over sibling reports is also missing, making it only partially complete.

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 100%, with two boolean parameters having clear descriptions and defaults. The tool description does not add significant meaning beyond the schema; it only mentions 'include VMs' and 'Excalidraw diagram', which are already in schema. Baseline 3 is appropriate.

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 that the tool generates a comprehensive As-Built report for the full Nutanix environment, covering all clusters, hosts, storage, networking, and VM inventory. It uses specific verb 'generate' and resource 'report', and distinguishes itself from siblings like generate_cluster_report and generate_vm_report by being environment-wide.

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 implies usage for a full environment overview but does not explicitly state when to use this tool versus alternative report tools (e.g., generate_cluster_report, generate_vm_report). No when-not or alternative guidance is provided, leaving the agent to infer context.

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