ibmcloud_resource_service_instance

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While 'Get' implies a read-only operation, the description does not mention output format, return value, authentication requirements, or how it handles non-existent instances. This is a significant gap for a tool with no annotation coverage.

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, front-loaded sentence with no filler words. It directly states the purpose in the simplest possible form, earning every word.

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 with one well-described parameter and no output schema, the description is minimally adequate but lacking. It doesn't explain what 'details' includes or what the response contains, and it doesn't mention any preconditions like being logged in. A more complete description would add context about the output or when to prefer this over the list variant.

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 fully describes the sole parameter ('name' with 'Service instance name or ID'), so schema coverage is 100%. The description does not add any additional parameter context beyond what the schema provides, such as format constraints or how the name is used. Baseline of 3 is appropriate.

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 ('Get details') and the resource ('service instance'). The singular resource distinguishes it from sibling 'ibmcloud_resource_service_instances' (which lists instances) and from create/delete/update siblings. This is a specific verb+resource+scope.

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 no guidance on when to use this tool versus alternatives. It does not mention that this is for retrieving a single instance by name or ID, nor does it exclude cases where listing instances might be more appropriate. No prerequisites or alternative tools are referenced.

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