Skip to main content
Glama

Cancel signing invite

cancel_invite
DestructiveIdempotent

Cancel all pending signing invites on a document or document group by ID, with optional reason.

Instructions

Cancel all active (pending) signing invites on a document or document group.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesID of the document or document group
entity_typeNoType of entity: 'document' or 'document_group' (optional). Auto-detected if not provided (tries document_group first). Pass explicitly to save one API call.
reasonNoOptional reason for cancellation

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesDocument or document group ID
entity_typeYesEntity type: 'document' or 'document_group'
statusYesResult status: 'cancelled' (invites were cancelled), 'invite_not_sent' (no active invite found), 'completed' (all signers already completed)
cancelled_invite_idsNoList of cancelled invite IDs (empty when status is not 'cancelled')
cancelled_invite_typeNoType of cancelled invites: 'field', 'freeform', or 'embedded' (populated only when status is 'cancelled')
Behavior4/5

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

Annotations already indicate destructive and idempotent behavior. The description adds context by specifying that it cancels 'all active (pending)' invites and applies to a document or document group. This is useful behavioral detail beyond the annotations.

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 a single, front-loaded sentence that efficiently conveys the action, scope, and type of invites affected. Every word is meaningful and no extraneous information is present.

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?

Given the tool's complexity (3 parameters, output schema present), the description is adequately complete. It covers the core behavior and scope. However, it could briefly note idempotency or the effect on already signed documents, though annotations partially cover that.

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%, so all parameters are described in the input schema. The description does not add additional meaning beyond what the schema already provides for entity_id, entity_type, or reason.

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 clearly states the verb 'Cancel' and the resource 'all active (pending) signing invites on a document or document group.' It specifies the action and scope, distinguishing it from sibling tools that send or create invites.

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

Usage Guidelines3/5

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

The description implies usage for canceling all pending invites, but it does not provide explicit when-to-use or when-not-to-use guidance, nor does it mention alternatives like update_invite_recipient or send_invite_reminder.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/signnow/sn-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server