update_project_affiliate_public

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

With no annotations, the description carries the full burden. It discloses that the tool performs a partial update, requires dry_run then confirmation, and uses project API key auth. It also mentions clearing tier_protection with null. No side effects or rate limits are noted, but the update nature is clear.

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?

The description is concise but packs essential information: endpoint, fields, auth, workflow, and an example. It is front-loaded and each sentence adds value. Slightly verbose due to the example but justified.

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 complexity (12 parameters, no output schema), the description covers authentication, workflow, partial update, and a dry_run example. It lacks response details and deep parameter descriptions, but for an update tool it is fairly complete.

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 description coverage is low (33%), but the description adds meaning for several parameters (e.g., 'tier_protection including null to clear', 'approve_project_tier_ids with reviewed_by_user_id'). However, some parameters like 'audiences' and 'region' are listed without additional context 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 states 'Updates a managed project affiliate' and provides the exact endpoint URL, making the operation clear and specific. It lists the updatable fields, distinguishing it from related tools like create_project_affiliate_public.

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 explains the authentication requirement (project API key only, not OAuth) and the dry_run-before-confirmed workflow. However, it does not explicitly state when to use this tool versus alternatives like creating or fetching affiliates.

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