Skip to main content
Glama

Revoke Document

revoke_document
DestructiveIdempotent

Revoke a document that has been sent for signing (only possible if not yet fully signed). Always call get_document first to confirm status, then show the user a summary and ask for confirmation — revoking is irreversible.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYesUnique identifier of the document to revoke

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

The description openly states that revoking is 'irreversible', which meaningfully supplements the annotations (destructiveHint=true, idempotentHint=true). It also discloses the conditional behavior based on signing status and mandates a confirmation step before invocation, giving the agent important behavioral context beyond the basic mutation flag.

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

Conciseness5/5

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

The description is compact, front-loaded with the core action and condition, and every sentence adds value. The prerequisite workflow is stated efficiently without unnecessary elaboration.

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

Completeness5/5

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

For a one-parameter destructive action with no output schema, the description covers the essential operational context: applicability condition, required pre-call, confirmation step, and irreversibility. Nothing critical is missing for an agent to invoke this tool correctly.

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?

The input schema fully documents the only parameter (documentId), so the description does not need to add parameter-level detail. Baseline of 3 applies because the parameter is already well-defined and there is no ambiguity about what the caller must provide.

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?

The description uses a specific verb ('Revoke') and names the exact resource type ('a document that has been sent for signing'), which clearly distinguishes it from generic deletion or creation tools. It also embeds a key scoping condition ('only possible if not yet fully signed'), making the tool's purpose unambiguous among siblings like delete_document and send_draft.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use guidance: only for documents already sent for signing and only if not fully signed. It also prescribes a required prerequisite workflow ('Always call get_document first... then show the user a summary and ask for confirmation'), which is concrete and actionable for an agent.

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