inventory_export

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

With no annotations provided, the description must fully disclose behavioral traits. It mentions output destinations and format constraints (mermaid local only), but fails to state that the operation is non-destructive, whether specific permissions are needed, or performance implications. This leaves behavioral expectations uncertain.

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, well-structured sentence that starts with the action verb and concisely states all key differentiators. No unnecessary words, and every part 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?

For a simple tool with no output schema, the description covers the main purpose and format distinctions. However, it omits context about prerequisites for remote export (e.g., server config), does not describe the output structure, and lacks behavioral transparency. It meets minimum viability but leaves gaps for an agent.

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 covers both parameters with descriptions (100% coverage), so baseline is 3. The tool description adds value by clarifying that mermaid output is a diagram and only local, while JSON can be local or remote. This semantic context goes beyond the schema descriptors.

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 uses a specific verb 'Export' and resource 'server inventory/topology', and explicitly lists the output formats (Mermaid diagram or JSON) and destinations (local or remote). This clearly distinguishes it from sibling tools like inventory_scan or report, making the purpose unambiguous.

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 like inventory_scan or network_scan. An agent would have to infer from the name and description alone, without any explicit when-to-use or when-not-to-use statements.

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