get-agreement-history
Get event history for an agreement: who changed what and when.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Get event history for an agreement: who changed what and when.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description adds the substance of the return ('who changed what and when'), but says nothing about ordering, pagination, or retention limits on the history.
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 tight sentence, front-loaded with the verb and the payoff of the call. Nothing wasted and nothing buried.
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?
An output schema exists, so return structure need not be described, and annotations cover safety. What is missing is the routing information an agent needs in a 40-tool namespace: why this history call and not list-agreement-history, and whether results are paged.
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?
One parameter at 0% schema description coverage in the metric sense, though the schema does label the UUID as the resource id. The description implies the agreement to look up but adds no format, scope, or versioning detail beyond that. Since the meaning is largely evident from the tool name, a baseline 3 is fair.
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 (get) and resource (agreement history), plus what the payload contains ('who changed what and when'). However, it does not distinguish itself from the sibling list-agreement-history, which an agent could easily pick instead.
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 guidance on when to use this versus list-agreement-history or get-agreement, and no prerequisites (e.g. that it requires an existing agreement id). The agent must infer selection from the name alone.
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.