Contract Testing: Create Secret

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

There is a clear annotation contradiction: the annotation declares readOnlyHint=true, indicating a read-only operation, while the description explicitly says 'Create a new secret' (a write operation). This is misleading and undermines trust. Beyond this, no additional behavioral traits (e.g., permissions, side effects, idempotency details) are disclosed.

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, with a clear header and structured parameter list. It front-loads the purpose. However, the parameter list is redundant with the schema, which could be omitted for brevity without losing information.

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?

The description covers the purpose and parameters adequately but fails to specify what the tool returns (e.g., the created secret object or confirmation). There is no output schema to compensate, so this omission limits completeness. The context implies secrets are used in webhooks, but missing return information.

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 description lists all parameters and adds the immutability constraint for teamUuid ('cannot be changed after creation'), which is not evident from the schema alone. However, it largely duplicates the schema descriptions (100% coverage), providing marginal additional value.

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 the action ('Create') and the resource ('secret'), and specifies the purpose ('for use in webhook authentication'). This distinguishes it from siblings like update_secret or delete_secret, providing immediate understanding of what the tool does.

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 does not provide guidance on when to use this tool versus alternatives (e.g., when to use contract-testing_create_secret vs. contract-testing_update_secret or contract-testing_get_secret). No prerequisites or exclusions are mentioned, leaving the agent to infer usage from the tool name alone.

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