get_sdn_controller

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

No annotations are present, so the description must disclose behavioral traits. It only states 'Get SDN controller configuration' without detailing what the configuration includes, whether it is read-only, or any side effects. The output schema exists but its content is not described.

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 very concise with two sentences. It front-loads the purpose and is free of unnecessary words. However, it could be slightly more structured to include parameter details more clearly.

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 simplicity (one parameter, output schema present but unknown content), the description is too minimal. It does not explain what 'SDN controller configuration' includes, leaving the agent uncertain about the return value and whether this tool fits a specific need.

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 0% description coverage, so the description adds some value by stating 'controller: Controller ID', clarifying the parameter's role. However, it does not specify the format or constraints beyond being a string ID.

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 the verb 'Get' and the resource 'SDN controller configuration', indicating it retrieves configuration for a specific controller. It distinguishes from the sibling 'list_sdn_controllers' which lists all controllers, but does not explicitly differentiate in the description.

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?

No usage guidelines are provided. The description does not indicate when to use this tool versus alternatives like 'list_sdn_controllers' or other 'get_' tools. There is no mention of prerequisites or scenarios.

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