Contract Testing: Publish Provider Contract

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

The description 'Publish' contradicts the annotation readOnlyHint=true, which indicates the tool is read-only. This is a serious inconsistency. Additionally, the description does not disclose behavioral traits such as authorization requirements or side effects beyond what annotations provide.

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 two sentences and a parameter list. It is front-loaded with the purpose. However, the parameter list is redundant given the schema, but not excessively long.

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 tool has moderate complexity with 6 parameters and nested objects. The description lacks information about return values or success indications. The annotation contradiction undermines trust in behavioral context. Without an output schema, the description should at least mention what happens upon successful publish.

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%, so the baseline is 3. The description lists parameters but essentially repeats the schema descriptions without adding new semantic meaning or usage context.

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 verb 'publish', the resource 'provider OpenAPI contract and self-verification results', and the destination 'PactFlow'. It distinguishes from sibling tools, such as contract-testing_publish_consumer_contracts, by specifying 'provider'.

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?

No explicit guidance on when to use this tool vs. alternatives. The description only mentions 'Toolset: Contracts' and does not provide exclusions or recommendations for when not to use it. Given the presence of sibling publish tools, guidance would be valuable.

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