generate-shareable-link
Generate a shareable review link for an agreement by UUID. Returns JSON with link URL.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| link | No |
Generate a shareable review link for an agreement by UUID. Returns JSON with link URL.
| Name | Required | Description | Default |
|---|---|---|---|
| pathParams | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| link | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true and destructiveHint=false, so the agent knows this is a mutating, non-idempotent external-facing operation. The description adds only the return shape ('Returns JSON with link URL') and does not address auth requirements, whether regenerating invalidates prior links, or link expiry/scope.
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?
Two short sentences, front-loaded with the action and resource and followed by the return hint. No filler or redundant restatement.
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?
With an output schema present, return-value detail is not needed, and annotations carry the mutation/safety profile. For a simple link-generation tool the definition is nearly sufficient; only link lifecycle behavior (expiry, regeneration) is unaddressed.
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?
Only one parameter (pathParams.id), and the schema itself documents it as the UUID of the agreement. The description's 'by UUID' reinforces but adds nothing new. Reported schema description coverage is 0% at the context level, so the description does minimal compensating work.
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 (generate), resource (shareable review link), target (an agreement) and key (by UUID). No sibling tool performs link generation, so the agent can place it unambiguously in the toolset.
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?
Usage is implied by the description ('generate a shareable review link for an agreement'), and no sibling competes for this action, so no explicit alternative routing is required. However, there is no stated precondition (e.g., agreement must exist/be in a shareable state) or when-not guidance.
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.