Get event annotations

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

Annotations already indicate readOnly, idempotent, and non-destructive behavior. The description adds the HTTP method and 'Body fields: none', which is useful, but it does not disclose any additional behavioral traits such as pagination or return format. It is consistent with annotations, so no contradiction.

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 brief and front-loaded with the purpose, followed by the endpoint and a reference link. It wastes no words, though it could include more usage context without becoming verbose.

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 tool with two parameters and no output schema, the description is incomplete. It does not mention what the tool returns (list vs single annotation), does not differentiate from the singular annotation tool, and does not reference pagination or other behavioral details beyond the schema.

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 description adds no information about the parameters. The schema covers the query parameter with offset/limit and pagination notes, but the eventID path parameter is undocumented. With schema coverage at 50%, the description does not compensate by explaining any parameters.

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 states a clear action: 'Get event annotations' with the REST endpoint, which identifies the resource and verb. It distinguishes itself from the sibling 'xmatters_get_an_event_annotation' by the plural form, though it does not explicitly say 'list all annotations'.

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?

No guidance is provided on when to use this tool versus alternatives. There is no mention of the difference from the singular annotation tool, no prerequisites, and no conditions that would make this tool the preferred choice.

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