Refresh document MCP tool
Refreshes expiring preview and download URLs for the show document widget.
- MCP tool name:
Refresh_Show_Document - Returns: Refresh document MCP response
- Annotations: Read only, not destructive, idempotent, closed world
Examples
Use this when an existing document viewer needs fresh preview or download URLs.
Refresh a government file preview and keep the same highlighted clause
{
"tool": "Refresh_Show_Document",
"arguments": {
"external_file_id": "<government_file_govtribe_id>",
"query": "evaluation criteria",
"scroll_to_query": true
}
}Refresh a shell artifact preview
{
"tool": "Refresh_Show_Document",
"arguments": {
"shell_file_identifier": "sandbox:/mnt/data/compliance-matrix.xlsx",
"query": "Section L",
"scroll_to_query": false
}
}Payload patterns
Pass exactly one file identifier: user_file_id, external_file_id, or shell_file_identifier.
Refresh an annotation-enabled document review
{
"tool": "Refresh_Show_Document",
"arguments": {
"external_file_id": "<government_file_govtribe_id>",
"query": "past performance",
"scroll_to_query": true,
"annotations": {
"enabled": true,
"tools": [
"highlight",
"note"
],
"helperText": "Mark the sections that need capture-team review.",
"submitLabel": "Submit review notes"
}
}
}Related articles
- Refresh document MCP response: Review the response shape returned by this tool.
- Source identifiers and record matching: Use GovTribe IDs and source identifiers when passing records between tools.
- Government file data type: Understand GovTribe-managed file records used by file and document tools.
- User file data type: Understand workspace-uploaded file records used by file and document tools.