Get shift occurrences

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

Annotations (readOnlyHint=true, idempotentHint=true, destructiveHint=false) already establish this is a safe read operation. The description adds minor clarifications about the URL structure and query parameters, but does not disclose pagination behavior, response contents, or rate limits. It does not contradict annotations.

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 relatively compact but includes internal referencing notes ('See C03', 'shared URL PARAMETERS table') that require external context and may confuse an agent. The core purpose is front-loaded but the extra reference material could be trimmed.

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 has no output schema and only partial schema coverage; the description mentions body fields are none and points to the API reference, but does not explain the return shape or typical use context. Given the read-only annotations and query parameter hints, it is adequate but not complete.

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 documents 'path.groupId' and a query object with documented names (embed, from, to, shifts, offset, limit). The description adds value by clarifying that 'shifts' is a query parameter not a path component and that pagination uses offset/limit without auto-combining results, which exceeds the schema's bare parameter listing.

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 title and description clearly state the tool retrieves shift occurrences for a group via a specific REST endpoint. It distinguishes itself from siblings like xmatters_get_a_shift and xmatters_get_shifts by focusing on occurrences, though it does not explicitly name those alternatives.

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 states the HTTP path and notes that 'shifts' is a query parameter, which clarifies usage, but it does not explicitly say when to prefer this tool over alternatives like get_deleted_shift_occurrences or get_on_call_summary. The context is implied rather than stated.

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