get_issue_changelog

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

The readOnlyHint annotation already tells the agent this is a safe read, and the description adds nothing beyond that - no mention of what the changelog contains (field diffs, authors, timestamps), pagination behavior, or ordering. With annotations covering the safety profile, the lowered bar still isn't met because the description contributes zero extra behavioral context.

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?

A single front-loaded sentence with no filler, which is appropriate sizing for a simple read. It is efficient but borders on under-specified rather than optimally informative.

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 three-parameter read tool with full schema coverage and readOnlyHint, the essentials are covered, so an agent can invoke it. It is silent on the shape of the history returned and on pagination expectations, which is a modest gap given there is no output 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?

Schema description coverage is 100%, so issueId, page, and perPage are all documented in the schema itself. The description adds no format or syntax detail beyond them, which lands at the baseline 3 for schema-complete tools.

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?

States a specific verb ('Get') and resource ('change history (changelog) of an issue'), which is clear enough to distinguish it from sibling readers like get_issue_comments or get_issue_worklog. It does not, however, explicitly differentiate itself from the closest sibling, get_entity_events, leaving the agent to guess between changelog and general events.

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 gives no when-to-use context, no prerequisites, and names no alternative tool. An agent must infer from the name alone whether this or get_entity_events is the right call for an issue's history.

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