read_migration

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

With no annotations, the description bears full disclosure burden; it does communicate that this is a static document fetch of a named file with a defined version scope, which is the key behavioral fact. It omits whether the content is read-only, paginated, or returns raw markdown, but for a zero-parameter fixed-file read these gaps are minor.

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 naming the file and its payload; every clause earns its place with no filler or redundancy.

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?

No output schema exists, so the description must signal the return content, and it does by listing the categories of information in the guide. Nothing an agent needs in order to call a parameterless document reader is missing, though the relationship to overlapping sibling docs remains unstated.

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 schema declares zero parameters, so there is nothing to disambiguate and the baseline is 4. The description's version range (v0.7 → v0.8) usefully clarifies that no version argument is needed, since the file is fixed.

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?

Names a specific resource (MIGRATION.md) and enumerates its contents (renames, removed features, breaking changes) plus the exact version range v0.7 → v0.8, so an agent knows what it gets. It does not explicitly differentiate itself from nearby siblings like read_changelog or read_versioning, which also cover version 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?

The version span 'v0.7 → v0.8' implies the usage condition (consult when migrating between those versions), but the description never states when to prefer this over read_changelog, read_versioning, or read_readme, nor any exclusions. Usage is left to inference.

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