uisp_get_gateway

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

There are no annotations, so the description carries the full burden of behavioral disclosure. It only restates the operation ('Get') and does not disclose what 'detail' includes, error behavior, authentication requirements, or whether the operation is read-only. The agent is left without information beyond the tool's purpose.

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?

One short sentence that is front-loaded with the action and resource. No empty words or redundancy. It effectively communicates the core purpose in the minimal space needed.

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?

The tool is a simple get-by-ID with a single well-described parameter, so the description plus schema might be sufficient for calling it. However, there is no output schema, and the description's vague 'detail' does not tell the agent what fields to expect in the response. This is a notable gap given the absence of structured output metadata.

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%, as the single parameter 'id' includes a description indicating the ID comes from uisp_list_gateways. The description adds no additional parameter meaning beyond the schema, so the baseline of 3 applies.

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?

States a specific verb 'Get', a specific resource 'gateway's detail', and the selection mechanism 'by ID'. This clearly distinguishes it from sibling list/search tools like uisp_list_gateways and uisp_search_sites.

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 does not explicitly state when to use this tool versus alternatives. However, the parameter schema hints at the intended workflow with 'Gateway ID (from uisp_list_gateways)', implying the tool should be used after listing gateways. No exclusions or alternatives are mentioned.

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