sophos_get_ip_host

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

Annotations already indicate readOnlyHint=true. The description adds that it 'Retrieve configuration details', which is consistent with read-only behavior. No additional behavioral traits are disclosed beyond what annotations provide.

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 succinct, with a clear one-sentence purpose, a usage line, and a structured Args/Returns section. Every part adds value, and the main action is front-loaded.

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 operation with an output schema present, the description covers the purpose, usage, parameters, and return value. It is complete given the tool's complexity and available structured information.

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 schema describes only the 'name' parameter; the 'client' parameter lacks description. The tool description clarifies 'client: Optional SophosFirewallClient instance', adding meaning for the otherwise undocumented parameter. Schema coverage is 50%, and description compensates.

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 'Retrieve' and resource 'configuration details for a specific IP host object'. It distinguishes itself from sibling tools like sophos_list_ip_hosts (which lists all) by specifying it targets a specific object by name.

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 context: 'Use when inspecting target IP address or subnet definition for an object.' It does not explicitly mention when not to use or alternative tools, but the context is clear enough.

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