affiliate_eduzz_get_programme

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

With no annotations, the description must carry the safety burden. It specifies a read operation ('Fetch'), the return type ('Returns a single Programme'), and the included fields (commission, status, advertiser URL). However, it does not address error cases, auth requirements, or rate limits, leaving some behavioral 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?

Three sentences, front-loaded with the action and resource, followed by usage guidance, return type, and pairing hint. 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?

For a simple one-parameter get tool with no output schema, the description covers purpose, when to use, parameter meaning, and return shape. It lacks error/edge-case details but is sufficiently complete for the complexity level.

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?

Schema coverage is 0%, so the description compensates by clarifying programmeId semantics: it is the network programme id and must already be known. It also instructs how to discover it via list_programmes, adding meaning beyond the bare 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 'Fetch a single programme on Eduzz by its network programme id' with a specific verb, resource, and scope. It distinguishes from siblings like list_programmes and get_programme for other networks.

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 gives the condition for use: 'when you already know the programme id and need its full record', and names the alternative: '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.