get_csm_case

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

The annotations already indicate readOnlyHint=true, so the agent knows this is a safe read operation. The description adds that it returns 'full details' and accepts both formats, but doesn't describe pagination, field selection, or error behavior. This is sufficient given the read-only annotation.

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 sentence, immediately states the action and target, and provides a specific example. It contains no unnecessary words or repetition.

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?

As a simple getter with one parameter and read-only annotation, the description sufficiently covers what the tool does and how to identify the record. The mention of 'full details' implies a comprehensive return, though no output schema is provided; but for this kind of tool, the information is adequate.

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 covers the single parameter with a description, but the tool description adds a concrete example (CS0001234), clarifying the expected format of the case number. This goes beyond the schema by providing a real-world pattern, which is helpful for correct invocation.

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 tool retrieves full details of a single CSM case, using a specific verb ('Get') and resource ('CSM case'). It also specifies the identifiers accepted (number or sys_id), distinguishing it from sibling tools like list_csm_cases, which list multiple cases.

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 clear context: use this when you need full details of a specific case identified by number or sys_id. It doesn't explicitly mention alternatives, but the identifier-based parameter implies it's not for browsing/searching, which is handled by sibling tools like list_csm_cases.

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