Skip to main content
Glama

PaperOffice AI

Get document details and metadata

po_documents_get
Read-onlyIdempotent

READ-ONLY. Returns data, changes nothing. Get document identity, processing state and compact trust.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pofidNoPaperOffice File ID (POFID). Copy byte-for-byte from po_documents_search. Hash prefix uses PaperOffice encoding (SHA-256 with digit 0 stored as letter O) — never replace O with 0. At least one of pofid or documents_id MUST be provided.
compactNoCompact mode (default true): core identity, classification, dates, summary, sender/recipient, amounts when present, plus capabilities and processing_state.
resolveNoVersioning: latest = return the CURRENT version of the document line even if pofid points to an older version (response.document.resolved_to_latest=true, requested_pofid keeps the input). Default exact = the given version.exact
documents_idNoNumeric document ID — alternative to pofid. At least one of pofid or documents_id MUST be provided.
include_pages_ocrNoWhen false (default), pages_ocr is omitted from the response — use po_documents_text_get for OCR text. Set true only when per-page OCR is required.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
hintNo
textNo
pofidNo
detailsNo
messageNo
summaryNo
currencyNo
_warningsNo
file_nameNo
retryableNo
error_codeNo
enforcementNo
http_statusNo
total_pagesNoPage count on the basis named in page_count_basis: source file pages, or rendered pages for Markdown/DOCX/XLSX/EML (then total_pages_source holds the source count)
capabilitiesNo
display_nameNo
documents_idNo
total_amountNo
workspace_idNo
document_typeNo
page_integrityNo
workspace_nameNo
_billing_summaryNo
page_count_basisNo
processing_stateNo
original_file_nameNo
total_pages_renderedNo
write_tools_in_profileNoWhether the write tool is registered on this connector (not a permission)
extraction_capabilitiesNo
effective_write_permissionsNoDocument capability ∩ token ACL, enforced server-side

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

The description reinforces the annotations by explicitly stating 'READ-ONLY' and 'changes nothing', matching readOnlyHint, idempotentHint, and destructiveHint. It adds little beyond those annotations, and it does not disclose versioning behavior or other potential gotchas, though the output schema covers return shape.

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?

The description is two short, front-loaded fragments with the most important behavioral signal ('READ-ONLY. Returns data, changes nothing') placed first. There is no filler, and every phrase pulls its weight.

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?

The tool is well-covered overall because the detailed input schema and output schema carry versioning, OCR, and return-shape information, while the description states the read-only contract. The narrative is slightly incomplete at the selection level because it doesn't connect this tool to po_documents_text_get or explain where pofid comes from, though the parameter descriptions partially compensate.

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%, and the parameter descriptions are already rich, covering pofid encoding, exact versus latest resolution, and pages_ocr behavior. The main description adds no parameter-level meaning, so the baseline of 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?

The description starts with 'READ-ONLY. Returns data, changes nothing' and names the specific resource and information returned: document identity, processing state, and compact trust. This clearly distinguishes it as a metadata/details getter rather than a write, search, or OCR-text retrieval tool.

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 description conveys that this is for read-only retrieval of document details, which gives clear context. However, it does not explicitly say when not to use it or name alternatives such as po_documents_text_get or po_documents_search; routing hints are largely left to the parameter descriptions.

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