void-agreement
Void an agreement so it is no longer valid or executable.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Void an agreement so it is no longer valid or executable.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is largely covered. The description adds the meaningful effect that the agreement becomes invalid/non-executable, but says nothing about reversibility, permissions, or side effects on related records.
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?
A single front-loaded sentence with no filler; the verb and resource lead and the clarifying clause follows efficiently. Every word earns its place.
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 destructive mutation with no output schema, the description covers purpose and effect and annotations cover the safety hints, but it omits prerequisites and downstream consequences. It is minimally adequate rather than fully informative.
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 reported at 0% and the description adds no parameter detail. However, there is only a single self-evident identifier parameter, so the missing explanation has limited impact on correct invocation.
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?
States a specific verb ("Void") and resource ("agreement") and clarifies the effect ("no longer valid or executable"). It is clearly distinct from siblings like get-agreement, create-agreement, and update-draft-agreement, though it does not explicitly name or route away from any alternative.
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 gives no guidance on when to void versus archive or otherwise terminate an agreement, no prerequisites (e.g., required permissions or agreement state), and no exclusions. An agent must infer the usage context entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.