Export

Render a document, page or table to a file and fetch it through a short-lived URL.

Tool	Scope	Kind
`export_document`	`documents:read`	read-only

export_document

Scope: documents:read (step-up) · Kind: read-only · Annotations: readOnlyHint: true, destructiveHint: false, openWorldHint: false

Render a document (markdown, pdf), page (html), or table (csv, json, markdown) to a file and get a short-lived download URL (~15 minutes; fetch it promptly). The file is a snapshot of the version it names — re-export after editing. Exporting never changes the artifact.

Parameters

string

required

The artifact id of a document, page or table.

'markdown' | 'html' | 'pdf' | 'csv' | 'json'

required

Which formats apply depends on the artifact kind:

Kind	Formats
`document`	`markdown`, `pdf`
`html_app`	`html`
`table`	`csv`, `json`, `markdown`

Returns

string

A capability URL on the server’s /files/ route. Valid for 15 minutes; access is re-checked at download time.

number

Milliseconds since epoch.

string

Derived from the title slug and format, for example q3-launch-plan.pdf.

string

number

The artifact version the file captures.

number

PDF only.

string[]

Renderer warning codes, if any.

Text: Exported "<title>" as <filename> (<media type>, <bytes> bytes). Download within 15 minutes: <url>

Permissions and side effects

Needs documents:read and any role on the artifact.
Uses the same renderer and cache as the app’s Export menu, so a second export of an unchanged version is served from cache.
Never changes the artifact. Recorded in the agent activity history.
Exports are not delivered into the pod as attachments; the URL is the only output.

Errors

`error`	Text	Cause
—	`Tool failed: \`format` must be one of markdown \| html \| pdf \| csv \| json`	Unknown format
`format_unavailable`	`That artifact cannot be exported as <Format> — documents export as markdown or pdf, pages as html, tables as csv, json or markdown.`	Format does not apply to the kind
`export_disabled`	`File export is turned off for this workspace.`	Workspace setting
`source_missing`	`That artifact has nothing in it to export yet.`	Empty artifact
`still_rendering`	`The file is still being produced — try once more shortly.`	Concurrent render in progress
`render_failed`	`The file could not be produced.`	Renderer error
—	`Tool failed: … Artifact not found`	Not visible, wrong workspace or no such id

Example

Request

{
  "name": "export_document",
  "arguments": { "document_id": "k97fq2example000000000000000000", "format": "pdf" }
}

Response (structuredContent)

{
  "filename": "q3-launch-plan.pdf",
  "media_type": "application/pdf",
  "byte_size": 48213,
  "source_version": 43,
  "page_count": 3,
  "warnings": [],
  "download_url": "https://mcp.sidecars.ai/files/r3nd1t10nexample.pdf?token=…",
  "expires_at": 1757161629000
}

The exact shape of the download URL is an implementation detail and may differ from the example; treat it as opaque and fetch it as-is.

Get started

Use it

Reference

export_document

Parameters

Returns

Permissions and side effects

Errors

Example

​export_document

​Parameters

​Returns

​Permissions and side effects

​Errors

​Example

export_document

Parameters

Returns

Permissions and side effects

Errors

Example