affiliate_optimise-media_get_programme

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

With no annotations provided, the description carries the full burden. It clearly indicates a read operation via 'Fetch', discloses the return type ('Returns a single Programme'), and enumerates key fields (commission, status, advertiser URL). It does not detail error behavior or auth requirements, but for a simple fetch-by-id tool this is solid behavioral transparency.

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, front-loaded with the core purpose, and every phrase earns its place. It covers purpose, usage context, return value, and relationship to a sibling tool without any 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?

For a tool with one required parameter, no annotations, and no output schema, the description covers what it does, when to use it, what it returns, and how it relates to list_programmes. It is complete enough for an agent to select and invoke correctly, though error-handling specifics are absent, so a perfect 5 is not warranted.

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 has one parameter, programmeId, with no description (0% coverage). The description compensates by explaining that this is the 'network programme id' and that it should already be known. This adds meaning beyond the bare schema, though it lacks format or example constraints.

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 starts with a specific verb+resource+scope: 'Fetch a single programme on Optimise Media by its network programme id.' It clearly distinguishes from the sibling list_programmes tool by focusing on fetching a single record by ID, and explicitly contrasts itself with list_programmes.

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 guidance: 'Use this when you already know the programme id and need its full record.' It also tells the agent to pair with list_programmes when discovery is needed, giving a clear alternative and workflow.

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