Skip to main content
Glama

Vault Documents

get_vault_documents
Read-onlyIdempotent

Canonical MCP read for vault document inventory. Each document includes its id. An own-Vault document also carries an X1-authored documentUrl for a direct link; use only that URL, never construct one from an id. On external professional connectors, use get_document_content or get_document_download_url once per document id when those tools are mounted. They require current download permission and household connected-document access, are rate limited, and record each release in household access history. Otherwise open the document in X1. On your own vault each document also carries summary, X1's one-line reading of it (null on a client's documents). Advisors and scoped specialists receive explicitly shared documents plus active visible coordination-thread attachments, while managed-program roles see metadata according to their assignment scope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax results (default 50)
categoryNoFilter by category
clientIdNoClient or member user ID
documentIdNoOptional document ID to poll one document's current indexing state.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Adds substantial context beyond the readOnly/idempotent annotations: never construct a documentUrl, rate limiting, access-history logging for each release, and the role-scoped visibility model (advisors, scoped specialists, managed-program roles). None of this is derivable from the schema or annotations.

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?

Purpose is front-loaded and each sentence carries information, but it is a dense single block that would scan better as grouped sentences (output fields vs. routing vs. permissions). Slight redundancy across the connector/X1 routing discussion.

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?

For a tool with no output schema, the description covers return contents (id, documentUrl, summary), the permission and rate-limit model, and role scoping. It stops short of describing pagination/limit behavior and how managed-program role metadata differs, but is otherwise complete.

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 documentId/limit/category/clientId are already documented. The description adds meaning only to the output fields (id, documentUrl, summary) and clarifies documentId can poll indexing state, but not parameter syntax. 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?

States a specific verb+resource ('Canonical MCP read for vault document inventory') and immediately distinguishes itself from search_documents and the per-document tools. An agent can tell what this returns (a document list with ids) without opening the schema.

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

Usage Guidelines5/5

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

Explicitly routes the agent: use get_document_content / get_document_download_url on external connectors once per document id when mounted, otherwise open in X1. It also cites prerequisites (download permission, connected-document access), so when-to-use and when-not are covered.

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.