TOOL API
get_ document
Get detailed information about a specific document by name. Requires: doc_name (string). Optional: wait_for_completion (boolean) to automatically wait up to 3 minutes if document is still processing. Returns document status, metadata, and intelligent next-step suggestions based on processing state and document size. Use this to check document readiness before get_document_structure() or get_page_content().
Call information
- Tool slug
- pageindex-mcp.get_document
- Provider
- PageIndex
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
doc_namerequiredCopy the `name` field verbatim from a browse_documents() or search_documents() response (case-sensitive, include extension). Example: "Q3 Report.pdf". If the response shows two documents with the same name, pass `folder_id` alongside to disambiguate.
folder_idDisambiguator for same-name documents. Copy the `folder_id` from the intended browse/search result; use "root" for root-level documents, or "shared-with-me"/"following" for the read-only folders at the library root; omit if `doc_name` is unique. Copy any folder_id verbatim from a browse_documents()/get_folder_structure() response, never construct one.
wait_for_completionIf true and document is processing, automatically wait up to 3 minutes until completed. Reduces repeated tool calls.