Award Achievement

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

Annotations only declare the non-read-only, non-idempotent, non-destructive profile; the description adds genuinely new behavior: the notification side effect and that the recipient may need to accept before it appears on their profile. It does not describe failure modes or rate limits, but it generously extends the annotation profile.

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 tight sentences, each front-loaded with a distinct fact: action, permission gate, duplicate behavior, notification consequence. No filler.

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 mutation tool with no output schema, the description gives the permission gate, idempotency-friendly duplicate note, and the recipient acceptance flow. It could mention what a successful award returns or error conditions, but the key decision inputs are covered.

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 75%, and the schema already documents achievementId formats and userCredentials fallback behavior. The description adds no parameter-level detail beyond naming the username target, so the baseline 3 for schema-heavy coverage is appropriate.

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 opens with a specific verb and resource ('Award an achievement to a GitLab username'), which the agent can immediately distinguish from sibling tools like revoke_achievement and create_achievement. The target entity (username) is explicit.

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?

It states the prerequisite permission (group Maintainer/Owner) and clarifies that repeated awards to the same user are permitted, which is exactly the kind of edge case an agent needs. It stops short of explicitly naming when to prefer revoke_achievement or create_achievement, so no explicit exclusions.

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