Skip to main content
Glama

Get an envelope

get_envelope

Envelope status, recipients, documents.

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": {
      "envelope_id": "<envelope_id>"
    },
    "name": "get_envelope"
  }
}

Input Schema

NameRequiredDescriptionDefault
api_keyNoDocuflex API key (dfx_live_...). Optional if sent as the x-docuflex-api-key header.
account_idNoDocuflex account id. Optional if sent as x-docuflex-account or if the key belongs to exactly one account.
envelope_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

D1.9/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden and largely fails it. It implies a read of envelope data but says nothing about authentication requirements (the api_key/account_id handling that the schema hints at), permission failures, or what happens for a voided/missing envelope.

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

Conciseness2/5

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

It is short, but not concise in a useful sense — it is a three-noun fragment that omits the verb and any framing. Nothing is front-loaded because there is effectively no sentence structure to front-load.

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

Completeness1/5

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

For a tool with three parameters, no annotations, no output schema, and a required identifier, this definition is far too thin. An agent has no information about return shape beyond three field names, no error or auth context, and no differentiation from the many sibling envelope tools.

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

Parameters2/5

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

Schema description coverage is only 67%: api_key and account_id are documented in the schema, but the sole required parameter, envelope_id, has no description anywhere. The tool description adds no meaning about what an envelope_id is or where to obtain it, so it does not compensate for the gap.

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

Purpose2/5

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

The description is a bare noun phrase, "Envelope status, recipients, documents," with no verb and no scope statement. It adds a little beyond the title by hinting at returned fields, but functionally it restates the name 'get_envelope' and gives no way to distinguish it from get_audit_trail, verify_envelope, or get_signing_url.

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

Usage Guidelines2/5

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

There is no when-to-use guidance at all: no prerequisites, no mention of when to prefer this over list_envelopes (for a single envelope) or verify_envelope (for validity checks). The agent must infer usage entirely from the tool name.

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