Skip to main content
Glama

List documents

list_documents
Read-onlyIdempotent

List your documents, newest first, optionally filtered by status (draft, sent, completed, declined, voided, expired), external_reference or metadata values.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum results, default 25, max 100.
statusNoOnly return documents with this status. Omit for all.
api_keyNoAn md2sign API key. When given, this call uses that key's account even if the connection is signed in as someone else, so pass it on every call when your human has more than one md2sign account (for example two businesses). Also use it if your MCP client cannot send an "Authorization: Bearer <api_key>" header.
metadataNoOnly return documents whose metadata has all of these exact values, e.g. {"customer_number": "C-1001"} or {"customer_number": "C-1001", "job_number": "J-77"}.
external_referenceNoOnly return documents with exactly this external_reference.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / external_reference
      Added value: +{
      +  "description": "Only return documents with exactly this external_reference.",
      +  "type": "string"
      +}
    • addedInput schema / properties / metadata
      Added value: +{
      +  "description": "Only return documents whose metadata has all of these exact values, e.g. {\"customer_number\": \"C-1001\"} or {\"customer_number\": \"C-1001\", \"job_number\": \"J-77\"}.",
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Your md2sign API key. Only needed if your MCP client cannot send an \"Authorization: Bearer <api_key>\" header."New value: +"An md2sign API key. When given, this call uses that key's account even if the connection is signed in as someone else, so pass it on every call when your human has more than one md2sign account (for example two businesses). Also use it if your MCP client cannot send an \"Authorization: Bearer <api_key>\" header."
  3. Changed1 schema field changed
    • addedInput schema / properties / status / description
      Added value: +"Only return documents with this status. Omit for all."
  4. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive closed-world behavior, so the safety profile is covered. The description adds one genuinely new behavioral fact — results come back newest first — but says nothing about what a returned document contains, whether results are paginated beyond the limit, or how large a result set can be.

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?

A single well-structured sentence that front-loads the verb, resource and sort order before listing filters. The only waste is re-listing the six enum values that the schema already declares.

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

Completeness3/5

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

For a five-parameter list tool with no output schema, the description covers filtering but omits what the response looks like (document summaries vs full documents) and whether there is any paging mechanism beyond limit. An agent can call it correctly, but cannot predict the return shape.

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%, so every parameter including limit, status, api_key, metadata and external_reference is already documented in structured fields. The description merely restates the filterable fields and repeats the status enum values, adding no syntax or matching semantics beyond the schema.

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

Purpose4/5

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

The description gives a specific verb and resource ("List your documents") plus the default ordering ("newest first") and the three filter axes, which clearly separates it from get_document, list_templates and list_webhooks. It stops short of explicitly naming a sibling alternative, so it is clear rather than exemplary.

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 word "optionally" signals that the filters are not required and the parenthetical enumerates the allowed statuses, which implies the browse-all vs filter-narrow usage. However, there is no when-not guidance and no pointer to get_document for fetching a single record, so the agent must infer the boundary.

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.