Skip to main content
Glama
signnow
by signnow

Get document or group details

get_document
Read-onlyIdempotent

Retrieve full document, template, or group details with current field values. Use after edits to get updated server-side state.

Instructions

Get full document, template, template group or document group information with field values. Always returns the current server-side state; call it again to pick up edits made in the SignNow editor after an earlier fetch.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idYesID of the document, template, template group or document group to retrieve
entity_typeNoType of entity: 'document', 'template', 'template_group' or 'document_group' (optional). If not provided, will be determined automatically

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
inviteNoUnified invite info
documentsYesList of documents in this group
entity_idYesDocument group ID
group_nameYesName of the document group
entity_typeYesType of entity: 'document' or 'document_group'
last_updatedYesUnix timestamp of the last update
freeform_invite_idNoFreeform invite ID, if a freeform invite exists on this entity

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Addedv2.4.0
  2. Removedv2.2.3
  3. Changed11 schema fields changedv2.2.1
    • addedInput schema / additionalProperties
      Added value: +false
    • removedOutput schema / $defs
      Removed value: -{
      -  "DocumentField": {
      -    "description": "Document field information.",
      -    "properties": {
      -      "id": {
      -        "description": "Field ID",
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Field name",
      -        "type": "string"
      -      },
      -      "role_id": {
      -        "description": "Role ID associated with this field",
      -        "type": "string"
      -      },
      -      "type": {
      -        "description": "Field type",
      -        "type": "string"
      -      },
      -      "value": {
      -        "description": "Field value",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "id",
      -      "type",
      -      "role_id",
      -      "value",
      -      "name"
      -    ],
      -    "type": "object"
      -  },
      -  "DocumentGroupDocument": {
      -    "description": "Document information for MCP tools.",
      -    "properties": {
      -      "fields": {
      -        "default": [],
      -        "description": "Fields defined in this document",
      -        "items": {
      -          "$ref": "#/$defs/DocumentField"
      -        },
      -        "type": "array"
      -      },
      -      "id": {
      -        "description": "Document ID",
      -        "type": "string"
      -      },
      -      "name": {
      -        "description": "Document name",
      -        "type": "string"
      -      },
      -      "roles": {
      -        "description": "Roles defined for this document",
      -        "items": {
      -          "type": "string"
      -        },
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "id",
      -      "name",
      -      "roles"
      -    ],
      -    "type": "object"
      -  }
      -}
    • removedOutput schema / properties / documents / items / $ref
      Removed value: -"#/$defs/DocumentGroupDocument"
    • addedOutput schema / properties / documents / items / description
      Added value: +"Document information for MCP tools."
    • addedOutput schema / properties / documents / items / properties
      Added value: +{
      +  "fields": {
      +    "default": [],
      +    "description": "Fields defined in this document",
      +    "items": {
      +      "description": "Document field information.",
      +      "properties": {
      +        "id": {
      +          "description": "Field ID",
      +          "type": "string"
      +        },
      +        "name": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "description": "Field name (may be absent for unnamed fields)"
      +        },
      +        "role_id": {
      +          "description": "Role ID associated with this field",
      +          "type": "string"
      +        },
      +        "type": {
      +          "description": "Field type",
      +          "type": "string"
      +        },
      +        "value": {
      +          "description": "Field value",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "type",
      +        "role_id",
      +        "value"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "id": {
      +    "description": "Document ID",
      +    "type": "string"
      +  },
      +  "name": {
      +    "description": "Document name",
      +    "type": "string"
      +  },
      +  "roles": {
      +    "description": "Roles defined for this document",
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +}
    • addedOutput schema / properties / documents / items / required
      Added value: +[
      +  "id",
      +  "name",
      +  "roles"
      +]
    • addedOutput schema / properties / documents / items / type
      Added value: +"object"
    • addedOutput schema / properties / freeform_invite_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Freeform invite ID, if a freeform invite exists on this entity"
      +}
    • addedOutput schema / properties / invite
      Added value: +{
      +  "anyOf": [
      +    {
      +      "properties": {
      +        "expired": {
      +          "default": false,
      +          "description": "Is invite expired",
      +          "type": "boolean"
      +        },
      +        "expires_at": {
      +          "anyOf": [
      +            {
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "description": "Unified invite expiration timestamp"
      +        },
      +        "invite_id": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "description": "Invite ID if present"
      +        },
      +        "participants": {
      +          "items": {
      +            "properties": {
      +              "action": {
      +                "anyOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Action (for document-group invites)"
      +              },
      +              "created": {
      +                "anyOf": [
      +                  {
      +                    "type": "integer"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Unix created timestamp"
      +              },
      +              "email": {
      +                "anyOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Participant email"
      +              },
      +              "expired": {
      +                "default": false,
      +                "description": "Is this participant expired",
      +                "type": "boolean"
      +              },
      +              "expires_at": {
      +                "anyOf": [
      +                  {
      +                    "type": "integer"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Unix expiration timestamp"
      +              },
      +              "order": {
      +                "anyOf": [
      +                  {
      +                    "type": "integer"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Signing order if present"
      +              },
      +              "role": {
      +                "anyOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Role (for document field_invites)"
      +              },
      +              "status": {
      +                "anyOf": [
      +                  {
      +                    "type": "string"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Raw participant status from API"
      +              },
      +              "updated": {
      +                "anyOf": [
      +                  {
      +                    "type": "integer"
      +                  },
      +                  {
      +                    "type": "null"
      +                  }
      +                ],
      +                "default": null,
      +                "description": "Unix updated timestamp"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "status": {
      +          "default": "unknown",
      +          "description": "Unified invite status. Values: pending (awaiting actions), created (created but not sent), completed (all actions done), declined (someone declined), expired (invite deadline passed), unknown (status could not be determined).",
      +          "type": "string"
      +        },
      +        "status_raw": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ],
      +          "default": null,
      +          "description": "Raw group-level invite status as returned by SignNow. Possible values depend on SignNow API (examples seen here: created, new, sent, pending, waiting, fulfilled, signed, completed, done, declined, rejected, canceled, cancelled, expired). created means the document was created but not sent."
      +        }
      +      },
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Unified invite info"
      +}
    • removedOutput schema / properties / invite_id
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Invite ID for this group"
      -}
    • removedOutput schema / properties / invite_status
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Status of the invite (e.g., 'pending')"
      -}
  4. Changed24 schema fields changedv1.0.0
    • changedInput schema / properties / entity_id / description
      Previous value: -"ID of the document or document group to retrieve"New value: +"ID of the document, template, template group or document group to retrieve"
    • removedInput schema / properties / entity_id / title
      Removed value: -"Entity Id"
    • changedInput schema / properties / entity_type / anyOf
      Previous value: -[
      -  {
      -    "enum": [
      -      "document",
      -      "document_group"
      -    ],
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "document",
      +      "document_group",
      +      "template",
      +      "template_group"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / entity_type / description
      Previous value: -"Type of entity: 'document' or 'document_group' (optional). If not provided, will be determined automatically"New value: +"Type of entity: 'document', 'template', 'template_group' or 'document_group' (optional). If not provided, will be determined automatically"
    • removedInput schema / properties / entity_type / title
      Removed value: -"Entity Type"
    • removedOutput schema / $defs / DocumentField / properties / id / title
      Removed value: -"Id"
    • removedOutput schema / $defs / DocumentField / properties / name / title
      Removed value: -"Name"
    • removedOutput schema / $defs / DocumentField / properties / role_id / title
      Removed value: -"Role Id"
    • removedOutput schema / $defs / DocumentField / properties / type / title
      Removed value: -"Type"
    • removedOutput schema / $defs / DocumentField / properties / value / title
      Removed value: -"Value"
    • removedOutput schema / $defs / DocumentField / title
      Removed value: -"DocumentField"
    • removedOutput schema / $defs / DocumentGroupDocument / properties / fields / title
      Removed value: -"Fields"
    • removedOutput schema / $defs / DocumentGroupDocument / properties / id / title
      Removed value: -"Id"
    • removedOutput schema / $defs / DocumentGroupDocument / properties / name / title
      Removed value: -"Name"
    • removedOutput schema / $defs / DocumentGroupDocument / properties / roles / title
      Removed value: -"Roles"
    • removedOutput schema / $defs / DocumentGroupDocument / title
      Removed value: -"DocumentGroupDocument"
    • removedOutput schema / properties / documents / title
      Removed value: -"Documents"
    • removedOutput schema / properties / entity_id / title
      Removed value: -"Entity Id"
    • removedOutput schema / properties / entity_type / title
      Removed value: -"Entity Type"
    • removedOutput schema / properties / group_name / title
      Removed value: -"Group Name"
    • removedOutput schema / properties / invite_id / title
      Removed value: -"Invite Id"
    • removedOutput schema / properties / invite_status / title
      Removed value: -"Invite Status"
    • removedOutput schema / properties / last_updated / title
      Removed value: -"Last Updated"
    • removedOutput schema / title
      Removed value: -"DocumentGroup"
  5. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds valuable context that it always returns the current server-side state and suggests re-fetching after edits, which goes beyond what annotations provide.

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?

Two concise sentences: the first states the core purpose, the second adds behavioral nuance. No redundant or extraneous information.

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?

Given the presence of an output schema, annotations, and full parameter coverage, the description adequately covers the tool's behavior. It explains the refresh behavior and entity types, making it complete for a read-only retrieval 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 has 100% description coverage with clear parameter descriptions. The description reinforces that entity_id refers to various entity types and mentions field values, but does not add substantive new details beyond the schema.

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 it retrieves full information for documents, templates, template groups, or document groups, including field values. It distinguishes itself from sibling tools like list_documents (list vs. get) and get_document_download_link (different purpose).

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 advises calling the tool again after editing to pick up changes, providing clear usage context. However, it lacks explicit guidance on when not to use it or comparisons to alternatives like view_document or get_invite_status.

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

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