getChangelogIDs

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

Describes return format (change records with affected id and type) and pagination behavior (empty page means no more changes). Declares read-only and mentions API key. Lacks details on pagination mechanics like total pages or rate limits, but sufficient for a simple listing.

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?

Single paragraph, front-loaded with main action, followed by details, use cases, alternatives, read-only note, param info, and requirement. No wasted words.

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?

Given the tool's simplicity (two nullable params, no output schema), the description covers the tool's purpose, usage, parameters, and output structure. Explains empty page case. Complete for a paginated changelog listing.

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?

Parameters page and limit are fully described in the schema. The description restates defaults and purpose, adding minimal context beyond the schema. Baseline 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 the tool lists IDs of recent changes (additions, renames, delistings) as a paginated feed, newest first. It provides specific use cases and distinguishes from sibling tool getCoins.

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?

Explicitly states when to use (sync/reconcile dataset, check recent changes) and when not to use (use getCoins for full list). Also mentions API key requirement (Starter+ plan).

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