get_ports

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

The description adds the key behavioral detail 'auto-detecting if none are set', which goes beyond the annotations (readOnlyHint, idempotentHint) and informs the agent that the tool can handle circuits without explicit port definitions. This is valuable context not captured elsewhere.

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, clear sentence with no redundant information. It is concise and front-loaded, effectively conveying the tool's purpose and key behavior.

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 one parameter and strong annotations, the description provides sufficient context: it states what is returned, for which resource, and a special behavior (auto-detection). No additional information is needed given the tool's simplicity.

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 description does not mention the parameter 'circuit_id' at all. With 0% schema description coverage, the description should compensate by explaining the parameter's purpose, format, or constraints, but it fails to do so.

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 action ('Return') and the resource ('port definitions for a circuit'), and the added behavior 'auto-detecting if none are set' distinguishes it from the sibling tool 'set_ports' which would set ports.

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 retrieving port definitions, but it does not explicitly mention when to use this tool versus the sibling 'set_ports' or any other alternative. The usage context is implied by the name and description, but no explicit guidance is provided.

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