Contract Testing: Publish Provider Contract

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

Annotations already provide the key behavioral profile: not read-only, idempotent, and non-destructive. The description adds context about PactFlow and bi-directional contract testing, but it does not describe side effects such as whether an existing contract is replaced or whether the provider must already exist. No contradiction with annotations.

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 purpose sentence is strong and front-loaded, but the parameter list largely duplicates the input schema and adds limited value. The 'Toolset: Contracts' line is minor filler. The description is not bloated, but it could be shorter and more additive.

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 six-parameter tool with a nested required contract object, the schema plus description cover all necessary input semantics, and the annotations cover the safety profile. It does not describe response or error behavior, and no output schema exists, but nothing critical is missing for invoking the tool correctly.

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 input schema has 100% parameter coverage with detailed descriptions, including nested fields like selfVerificationResults. The description repeats definitions such as 'contract (object): Provider contract...' without adding new constraints, examples, or clarifications beyond the schema.

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 opening sentence is explicit: 'Publish a provider OpenAPI or AsyncAPI contract and self-verification results to PactFlow.' This gives a specific verb, resource, and target system. The 'provider' wording also distinguishes it from the sibling publish_consumer_contracts tool.

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 makes the intended use clear: publish a provider contract with self-verification details to PactFlow. It does not explicitly name alternatives or say when not to use it, but the provider-focused wording is enough to route an agent to the correct sibling tool in most cases.

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