affiliate_affilae_get_programme

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

No annotations provided, so description carries the burden. It clarifies this is a read operation ('Fetch') and specifies return contents (commission, status, advertiser URL). Does not mention failure behavior or auth, but for a simple getter this is reasonable coverage.

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, each with a distinct purpose: action, usage scenario, and pairing advice. 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 no output schema, the description covers the return type and key fields, plus connection to list_programmes. It is complete for a single-parameter fetch tool; minor gap is no error-handling details, but not necessary for a straightforward getter.

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 parameter programmeId is described as 'network programme id', adding meaning beyond the bare schema. The guidance to pair with list_programmes also indirectly explains how to obtain the id. Lacks format/examples, but with one parameter this is helpful.

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?

States 'Fetch a single programme on Affilae by its network programme id' – a specific verb, resource, and network. Clearly distinguishes from other get_programme tools via network name and single-record scope.

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 says 'Use this when you already know the programme id and need its full record' and contrasts with list_programmes for id discovery. This gives concrete when-to-use guidance and an alternative.

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