Skip to main content
Glama

signvoy_void_document

Destructive

Void a document, revoking all outstanding signing links. This is irreversible — the document cannot be re-sent. Only appropriate when the document must be withdrawn before completion. ALWAYS confirm with the user before calling this tool.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "document_id": "<document_id>"
    },
    "name": "signvoy_void_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_idYesDocument UUID to void. Action is irreversible.
workspace_idNoTarget workspace UUID. Safe to omit only when the user belongs to exactly one workspace; required otherwise, and omitting it then fails with the list of candidates. Call signvoy_list_workspaces to find it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false, but the description adds the substance those flags lack: outstanding signing links are revoked and the document cannot be re-sent. It does not state the resulting document status or what happens to partially signed copies, which would complete the blast-radius picture.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four short sentences, front-loaded with the action and effect, then the irreversibility warning, then the confirmation rule. Every sentence carries distinct information, though the irreversibility point is stated twice ('cannot be re-sent' / 'Only appropriate when... withdrawn').

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive two-parameter mutation with annotations and no output schema, this covers the essentials: effect, irreversibility, scope, and required user confirmation. The remaining gap is the post-void document state, which an agent might want before acting.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the schema itself already explains the document_id irreversibility and the workspace_id single-workspace fallback with a pointer to signvoy_list_workspaces. The description adds no parameter-level meaning beyond it, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Void a document') plus the concrete effect ('revoking all outstanding signing links'). 'Void' is distinct from every listed sibling (send, remind, update, create_signing_link), so an agent can tell this apart without opening another schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly scopes use to 'when the document must be withdrawn before completion' and adds a hard workflow gate ('ALWAYS confirm with the user before calling this tool'). It stops short of naming what to do instead when the goal is to correct rather than withdraw a document, so no true alternative routing is given.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources