pve_sdn_fabric_status_routes

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

Description explicitly declares 'READ-ONLY', indicating safety. Explains nexthops are wire-learned. No annotations present, so description carries burden; it provides good behavioral context.

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?

Concise two-sentence structure with key information front-loaded. No unnecessary words.

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 output schema exists, description covers purpose, read-only, and data source. Lacks error handling or prerequisites, but adequate for a focused status tool.

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%, so baseline 3. Description adds minimal extra parameter context (e.g., routes per node) but doesn't significantly augment schema descriptions.

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?

Description clearly states verb 'get', resource 'routes for a fabric on one node', and format (CIDR + nexthops). Distinguishes from sibling fabric status tools by specifying routes.

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?

Implied usage from name and description, but no explicit when-to-use or alternatives provided. Agent can infer use case from 'get all routes', but lacks guidance on when not to use.

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