Skip to main content
Glama

signvoy_get_document_status

Read-only

Get the current status of a document and per-recipient signing state. Returns status, the signing deadline (expiresAt), when the automatic final pre-deadline reminder is due (finalReminderAt), and a row per recipient with their current signing state (pending / signed / declined). Each recipient includes lastRemindedAt (when they were last reminded, for rate limiting) and hasActiveSigningLink (whether they can currently sign - respects sequential workflow). Use recipients[].id as document_recipient_id when calling signvoy_create_signing_link or signvoy_remind_recipient.

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_get_document_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_idYesDocument UUID from signvoy_list_documents.
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.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds real behavioral context beyond that: the meaning of lastRemindedAt (rate limiting) and hasActiveSigningLink (respects sequential workflow). It does not describe failure behavior, such as what happens with an invalid or inaccessible document_id.

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?

The purpose is front-loaded in the first clause, followed by the returned fields, then the follow-on routing. The parenthetical clarifications earn their place by defining ambiguous fields, though the enumeration of return values is dense and could be tightened slightly.

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?

With no output schema, the description takes on the job of explaining return values and does so thoroughly: status, expiresAt, finalReminderAt, and a per-recipient row with state, lastRemindedAt, and hasActiveSigningLink. Combined with the fully documented params, an agent has what it needs to call and interpret this tool.

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 description coverage is 100%, and the schema already explains the document_id source and the workspace_id omission rule in detail. The description adds nothing about either parameter, which is acceptable given the schema carries that burden, 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?

The description opens with a specific verb and resource ('Get the current status of a document') and immediately scopes it to per-recipient signing state. That distinguishes it cleanly from siblings like signvoy_get_audit_trail or signvoy_get_signed_pdf_url.

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?

It provides clear downstream routing: use recipients[].id as document_recipient_id when calling signvoy_create_signing_link or signvoy_remind_recipient. What it lacks is an explicit when-to-use-this-instead-of-X statement (for example, versus the audit trail for historical events), so it stops short of a 5.

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