Skip to main content
Glama

Document navigation

get_document_navigation
Read-onlyIdempotent

Retrieve a document navigation index including PDF outline, page previews, and keyword-matched landmarks. Use to select page ranges for fetching authoritative content from large cached documents.

Instructions

Return a navigation index for a cached document: PDF outline / bookmarks, per-page text previews (~200 chars each), keyword-matched landmarks (balance sheet / directors report / auditor report), text-layer classification, and source URLs.

Call this FIRST for PDFs too large to fit in a single document block (fetch_document returned kind='resource_link'). Use the outline / previews / landmarks to pick a page range, then re-call fetch_document with pages='N-M' for the authoritative content.

Navigation aids only: page previews, outline titles, landmark matches, and snippets may be truncated or contain OCR errors. NEVER cite them as source material for figures, quotes, dates, or names — always quote from a subsequent fetch_document page-range fetch. Requires the document bytes to already be cached via fetch_document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
jurisdictionYesISO 3166-1 alpha-2 country code (uppercase). All registries are official government sources. Currently supported: AU, BE, CA, CA-BC, CA-NT, CH, CY, CZ, DE, ES, FI, FR, GB, HK, IE, IM, IS, IT, KR, KY, LI, MC, MX, MY, NL, NO, NZ, PL, RU, TW. Per-country capability, ID format, examples, status mapping, and caveats: call `list_jurisdictions({jurisdiction:'<code>'})`. To find which countries support a specific tool: `list_jurisdictions({supports_tool:'<tool>'})`.
document_idYesDocument ID from list_filings; document must already be cached via fetch_document.
freshNoRe-run pdfjs against the cached bytes (does not re-pull from upstream).
company_idNoOverride; auto-resolved from list_filings side-cache.
transaction_idNoOverride; auto-resolved from list_filings side-cache.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queried_atYesISO-8601 + Europe/London timezone stamp for when the registry was queried.
jurisdictionNo
document_idNo
pagesNo
headingsNo
outlineNo
Behavior5/5

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

Adds beyond annotations: mentions precondition (document must be cached), notes truncation/OCR errors, and warns not to cite directly. No contradiction with 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?

Three paragraphs with clear structure: purpose, usage, caveats. Front-loaded with purpose. Each sentence adds value; no redundancy.

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?

Given tool complexity, high schema coverage, and annotations, the description fully addresses purpose, preconditions, usage, and limitations. Output schema exists, so return values need not be detailed.

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% with detailed descriptions for all 5 parameters. Description adds limited new parameter-specific info (e.g., caching requirement) but baseline is 3 due to high schema coverage.

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?

Description clearly states it returns a navigation index for cached documents, listing specific elements (outline, previews, landmarks). It distinguishes from sibling fetch_document by advising to call this first for large PDFs.

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 says to call this first for large PDFs, then use fetch_document with page range for authoritative content. Also warns that navigation aids are not reliable for citations, guiding proper usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sophymarine/openregistry'

If you have feedback or need assistance with the MCP directory API, please join our Discord server