Show document MCP response
MCP tool response returned by the Show document MCP tool.
- Returned by: Show document MCP tool
- Response type: Structured app payload
Response Shape
The response describes the document viewer payload. When annotations are enabled, it also includes interactive annotation state.
| Field | Type | Notes |
|---|---|---|
id | string | GovTribe user file or government file identifier. |
govtribe_type | string | user_file or government_file. |
title | string | Display title for the document. |
filename | string | Source filename. |
extension | string | Lowercase file extension. |
mime_type | string or null | MIME type when known. |
viewer_url | string | Temporary URL for previewing the document. |
open_url | string | Temporary URL used to open the document. |
download_url | string | Temporary URL used to download the document. |
url_expires_at | string | ISO timestamp for the temporary URL expiration. |
govtribe_url | string | GovTribe web URL for the file record. |
query | string or null | Optional search text to locate in the document. |
scroll_to_query | boolean | Whether the viewer should scroll to the query. |
viewable | boolean | Whether the file can be previewed in the document app. |
interactionId | string | Present when annotations are enabled. |
kind | string | document_annotation when annotations are enabled. |
status | string | Initial annotation status, usually pending. |
annotationConfig | object | Annotation tool and submit-label configuration. |
annotations | array | Normalized annotation list. Starts empty. |
annotationCount | integer | Count of submitted annotations. Starts at 0. |
xfdf | string or null | XFDF annotation state when present. |
lastChangedAt | string or null | Last annotation change timestamp when present. |
Follow-up Behavior
Use Refresh document MCP response when preview URLs need to be refreshed. Use Interaction state MCP response to read or persist annotation state for interactive document markup.
Example
{
"id": "FILE_ID",
"govtribe_type": "government_file",
"title": "Solicitation attachment",
"filename": "solicitation.pdf",
"extension": "pdf",
"mime_type": "application/pdf",
"viewer_url": "https://govtribe.com/temporary/files/FILE_ID/view",
"open_url": "https://govtribe.com/temporary/files/FILE_ID/open",
"download_url": "https://govtribe.com/temporary/files/FILE_ID/download",
"url_expires_at": "2026-05-06T13:00:00+00:00",
"govtribe_url": "https://govtribe.com/files/FILE_ID",
"query": "delivery schedule",
"scroll_to_query": true,
"viewable": true,
"interactionId": "document_annotation:INTERACTION_ID",
"kind": "document_annotation",
"status": "pending",
"isInteractive": true,
"document": {
"id": "FILE_ID",
"govtribeType": "government_file",
"title": "Solicitation attachment",
"filename": "solicitation.pdf",
"extension": "pdf",
"mimeType": "application/pdf"
},
"annotationConfig": {
"enabled": true,
"tools": ["highlight"],
"helperText": "Mark important sections.",
"submitLabel": "Submit annotations"
},
"annotations": [],
"annotationCount": 0,
"xfdf": null,
"lastChangedAt": null
}