pve_sdn_controller_get

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

With no annotations provided, the description carries the full burden. The READ-ONLY prefix clearly indicates no destructive behavior, which is the primary concern. It doesn't detail auth requirements or rate limits, but for a simple read tool this is adequate.

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?

Two short sentences, each earning its place. The READ-ONLY prefix is front-loaded, followed by the core action and a usage hint. 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?

For a simple read tool, the description is complete: it specifies the object (SDN controller), the action (read configuration), the prerequisite (list IDs), and the read-only nature. An output schema exists to document return values.

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%, so the schema already documents all parameters. The description adds no additional parameter semantics beyond stating the tool reads a configuration, which the schema already implies for the 'controller' parameter.

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 explicitly states 'read one SDN controller's configuration', using a clear verb-resource pair. It distinguishes itself from sibling tools like pve_sdn_controllers_list by indicating it's for a single controller rather than enumeration.

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 explicit guidance to 'Use pve_sdn_controllers_list to enumerate controller ids first', which is a clear prerequisite. It also labels the tool as READ-ONLY, indicating safe usage.

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