Contract Testing: Create Secret

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

Annotations already indicate this is a mutating, non-idempotent, non-destructive operation, and the description does not contradict that. It adds the useful constraint that teamUuid cannot be changed after creation, though that is also present in the schema; it does not disclose response behavior or permission requirements.

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 short and front-loaded with the core purpose. However, the parameter list duplicates the input schema, so a meaningful portion of the description does not add value beyond the structured fields.

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 create operation, the description covers the main intent and required fields, but with no output schema it does not clarify what the response contains or whether the secret value is shown only once. Permission requirements and default team behavior are also not addressed.

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 100%, and the description repeats the schema's parameter descriptions almost verbatim. It adds minimal extra meaning beyond restating that name and value are required and that teamUuid is immutable after creation.

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 uses a specific verb and resource: 'Create a new secret for use in webhook authentication.' It clearly identifies what the tool does and distinguishes it from sibling secret tools like list_secrets, get_secret, update_secret, and delete_secret.

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 purpose statement implies the tool should be used when a new secret is needed for webhook authentication, and the 'Toolset: Secrets' label provides some context. However, it does not explicitly state when to prefer this over related tools or mention any prerequisites or exclusions.

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