affiliate_adrecord_get_programme

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

No annotations are provided, so the description carries the burden. It does disclose that it returns a single Programme and lists included fields, but it does not explicitly state read-only behavior, authentication requirements, or error behavior for an invalid id. It adds some context but leaves gaps.

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?

Two sentences, no fluff, and the main action is front-loaded. Every sentence provides useful information about what, when, and how to use the tool.

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?

For a simple single-fetch tool with one parameter and no output schema, this description is complete: it states the purpose, the exact parameter semantics, the return type, and the related tool flow. No critical details are missing.

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 only defines programmeId as a string with no description. The description compensates by clarifying it is the 'network programme id' and advises using list_programmes to discover it first, which adds meaning 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 a single programme by its network programme id, and specifies the content of the full record (commission, status, advertiser URL). This distinguishes it from list_programmes which discovers ids.

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 gives explicit when-to-use guidance ('Use this when you already know the programme id and need its full record') and explicitly names the alternative for discovery ('pair with list_programmes when you need to discover the id first').

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