issue_changelog

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

With no annotations provided, the description carries the full burden of behavioral disclosure. However, it only restates the tool's function without detailing side effects, pagination behavior, filtering capabilities, or output format. It does not contradict annotations, but it adds minimal context beyond the tool name.

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, tight sentence that immediately conveys the tool's purpose without unnecessary words. It is front-loaded and concise, with no filler content.

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 a rich schema (100% parameter coverage) and an output schema, so the return values and parameters are documented. However, the description lacks usage guidance and does not clarify how this tool relates to entity_changelog or get_issue. It is minimally viable but leaves contextual gaps.

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 the schema fully documents all four parameters, including field, per_page, issue_key, and output_format. The description adds no parameter-level semantics, but with complete schema coverage, the 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 'Get issue changelog' with a parenthetical definition 'history of changes,' making the verb and resource explicit. It distinguishes itself from siblings like get_issue and entity_changelog by focusing specifically on issue changelog history.

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 exclusions or when to prefer entity_changelog or get_issue, leaving the agent to infer usage context.

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