Get ticket diff

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

The description fully discloses behavioral traits: read-only, truncation with notice, omission of later commits when over cap, and warning instead of error for missing codeLocation or no matching commits. Annotations confirm readOnlyHint, and the description adds deeper context beyond that.

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 front-loaded with the core purpose and structured well, but it is somewhat verbose with extensive detail on the semantic parameter. Every sentence adds value, though some trimming could improve conciseness.

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?

Despite no output schema, the description explains return values (per-commit summary, diff, truncation, warning) and handles edge cases (missing codeLocation, no commits). It covers all necessary context for an agent to use the tool correctly.

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 meaning beyond the schema for parameters like maxBytes (truncation behavior) and semantic (details of the semantic view). For project and ticket, which lack schema descriptions, the context is implied but not explicitly defined. Overall, it provides useful additional semantics.

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 captures code changes for a ticket by finding commits mentioning the ticket id and returning per-commit summaries plus a diff. The verb 'get' and resource 'ticket diff' are explicit, and the scope (from project's code repo) uniquely distinguishes it from siblings like list_code_files or read_code_file.

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 explains when the tool is read-only and warns about truncation and non-error warnings, providing usage context. However, it does not explicitly state when to prefer this tool over alternatives or when not to use it, missing clear exclusions.

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