Contract Testing: Regenerate API Token

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

The description says 'Regenerate' implying a destructive action, but annotations declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true. This is a clear contradiction; regenerating a token changes it and is not idempotent. The description does not disclose any behavioral traits that resolve this inconsistency.

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 a single succinct sentence plus a toolset and parameter list. No redundant information. It is front-loaded and efficient.

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 mutation with one parameter, the description provides the core action. However, it lacks details on side effects, return value, or failure modes. Annotations are contradictory, which reduces completeness.

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 only parameter tokenId is described in both the schema and description. Schema coverage is 100%, so the description adds no new semantic meaning beyond the schema. Baseline score of 3 applies.

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 'Regenerate (rotate) an API token by ID.', which is a specific verb and resource. Among siblings, there are other token-related tools like list_api_tokens, but this one uniquely handles regeneration.

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 includes a toolset hint ('User, Tokens and Preferences') but does not explicitly state when to use this tool versus alternatives like list_api_tokens, create_secret, or delete_secret. No guidance on prerequisites or when not to use it.

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