Get Migration Guide

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

Annotations already indicate readOnly, destructive=false, idempotent, openWorld. The description adds context about targeted file types (MIGRATION.md, CHANGELOG, etc.) and differentiates between upgrade instructions and release notes, improving transparency beyond 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?

Three concise sentences front-load the core purpose, then add prerequisite and usage disambiguation. No redundant words; every sentence adds value.

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?

Covers purpose, prerequisites, usage alternatives, and parameter context. Lacks explicit return format, but given readOnlyHint and the nature of migration guides (textual output), the description is sufficiently complete for the AI to use the tool appropriately.

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%, providing clear definitions for all parameters. The description adds minimal extra (e.g., version format examples like '14', 'v3.0'), but does not significantly enhance understanding beyond the schema.

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 fetches migration guides, breaking changes, and upgrade instructions for a library. It specifies the verb 'fetch' and resource, and later distinguishes from sibling gt_changelog, making the purpose unambiguous.

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?

Provides explicit when to use (user asks how to upgrade) and when not to (use gt_changelog for release notes without upgrade instructions). Also advises to call gt_resolve_library first for libraryId, offering a clear use-case framework.

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