Skip to main content
Glama

Search My Document Contents

search_my_document_contents
Read-onlyIdempotent

Search the text (body contents) of the connected person's own documents in X1, such as trusts, policies, agreements, and K-1s, when they ask what their own documents say. Returns the matching passages with document and page, sheet, or section so you can answer from them and cite the page; it does not write the answer itself. To search by document name, title, or tag instead, use the document metadata search if one is offered. To compare known files, pass up to 10 authorized documentIds in one request instead of parallel per-file calls. all_requested coverage requires a matching passage from every selected document; best_effort can return partial evidence. Neither is a complete page-by-page review. If rate-limited, wait for outstanding searches and retry one at a time. Indexing is asynchronous after every save; a just-saved document may return an honest still-indexing state with an instruction to try again shortly. Governed retrieval contract: x1-vault-v1.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum source passages to return. Defaults to 6.
queryYesSearch text for your own indexed X1 Vault documents.
clientIdNoOptional member ID bound to the authenticated X1 surface.
coverageNoDefaults to best_effort. With a document selection, all_requested requires a matching passage from each selected document or returns no passages. This is passage coverage, not a complete document review.
documentIdsNoOptional IDs from an authorized document inventory. Search up to 10 selected documents in one request for comparisons; omit to search your readable Vault. IDs never grant access.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countYes
errorNo
indexedYes
matchesYes
messageYes
coverageNo
degradedNo
indexingNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / coverage
      Added value: +{
      +  "description": "Defaults to best_effort. With a document selection, all_requested requires a matching passage from each selected document or returns no passages. This is passage coverage, not a complete document review.",
      +  "enum": [
      +    "best_effort",
      +    "all_requested"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / documentIds
      Added value: +{
      +  "description": "Optional IDs from an authorized document inventory. Search up to 10 selected documents in one request for comparisons; omit to search your readable Vault. IDs never grant access.",
      +  "items": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedOutput schema / properties / coverage
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "allRequestedRepresented": {
      +      "type": "boolean"
      +    },
      +    "kind": {
      +      "const": "matching_passages",
      +      "type": "string"
      +    },
      +    "matchedDocumentCount": {
      +      "maximum": 9007199254740991,
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "requestedDocumentCount": {
      +      "exclusiveMinimum": 0,
      +      "maximum": 9007199254740991,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "allRequestedRepresented",
      +    "kind",
      +    "matchedDocumentCount",
      +    "requestedDocumentCount"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / error
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "code": {
      +      "const": "rate_limited",
      +      "type": "string"
      +    },
      +    "requestId": {
      +      "maxLength": 128,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "retryable": {
      +      "const": true,
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "requestId",
      +    "retryable"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world). The description adds genuinely new behavioral context: rate-limit handling ('wait for outstanding searches and retry one at a time'), asynchronous indexing with a 'still-indexing' state, and the fact it returns passages rather than writing an answer. This meaningfully exceeds the annotation set.

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 and scope are front-loaded, and nearly every sentence carries routing or behavior information. It is dense with parentheticals and could shed a clause or two, but there is little pure filler.

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?

An output schema exists, so return values need not be re-explained. The description still covers the tricky edges an agent needs: coverage semantics, asynchronous indexing, rate limiting, and the governed retrieval contract. Nothing material is missing for correct invocation.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds real meaning: it explains the coverage enum trade-off, that documentIds allow up to 10 comparison targets in one request, and that 'IDs never grant access.' Only 'limit' is left entirely to 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?

States a specific verb and resource: 'Search the text (body contents) of the connected person's own documents in X1,' with examples (trusts, policies, agreements, K-1s). It also explicitly distinguishes itself from the metadata/name search sibling, so an agent can route without opening a 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?

Gives explicit when ('when they ask what their own documents say'), a named alternative for a different axis ('to search by document name, title, or tag instead, use the document metadata search'), and a scoping trigger for documentIds ('to compare known files'). When/when-not/alternatives are all present.

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.