Skip to main content
Glama
transkribus-mcp-server

transkribus-mcp-server

by lazyants

Export Document

transkribus_doc_export

Starts a document export job with chosen formats (PDF, TEI, DOCX, ALTO, PAGE XML, METS, images, XLSX), page ranges, and format-specific options.

Instructions

Start an export job for a document. Choose formats in commonPars and set format options in altoPars, pdfPars, teiPars or docxPars.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "collId": "<collId>",
      "id": "<id>"
    },
    "name": "transkribus_doc_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument ID
pagesNoPage range to export, e.g. "1-5,8"; all pages when omitted
collIdYesCollection ID
pdfParsNoPDF options
teiParsNoTEI options
altoParsNoALTO options
docxParsNoDOCX options
commonParsNoFormats and common options. Defaults: METS, images, PAGE XML and ALTO of the latest version

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed40 schema fields changedv4.2.0
    • addedInput schema / properties / altoPars
      Added value: +{
      +  "description": "ALTO options",
      +  "properties": {
      +    "altoVersion": {
      +      "enum": [
      +        "2.0",
      +        "4.0",
      +        "4.4"
      +      ],
      +      "type": "string"
      +    },
      +    "createAltov2": {
      +      "type": "boolean"
      +    },
      +    "exportStructureTags": {
      +      "type": "boolean"
      +    },
      +    "exportTextStyleTags": {
      +      "type": "boolean"
      +    },
      +    "splitIntoWordsInAltoXml": {
      +      "type": "boolean"
      +    },
      +    "useFilenameAsPageId": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / commonPars
      Added value: +{
      +  "description": "Formats and common options. Defaults: METS, images, PAGE XML and ALTO of the latest version",
      +  "properties": {
      +    "doBlackening": {
      +      "type": "boolean"
      +    },
      +    "doCreateTitle": {
      +      "type": "boolean"
      +    },
      +    "doExportAltoXml": {
      +      "description": "Export ALTO XML (options in altoPars)",
      +      "type": "boolean"
      +    },
      +    "doExportDocMetadata": {
      +      "description": "Export document metadata to metadata.xml",
      +      "type": "boolean"
      +    },
      +    "doExportPageXml": {
      +      "description": "Export PAGE XML",
      +      "type": "boolean"
      +    },
      +    "doExportSingleTxtFiles": {
      +      "description": "Export one TXT file per image",
      +      "type": "boolean"
      +    },
      +    "doIncludeImagesInXlsx": {
      +      "type": "boolean"
      +    },
      +    "doResume": {
      +      "type": "boolean"
      +    },
      +    "doWriteDocx": {
      +      "description": "Export DOCX (options in docxPars)",
      +      "type": "boolean"
      +    },
      +    "doWriteImages": {
      +      "description": "Export the image files",
      +      "type": "boolean"
      +    },
      +    "doWriteMets": {
      +      "description": "Write mets.xml (metadata, pagination)",
      +      "type": "boolean"
      +    },
      +    "doWriteOneTableForDoc": {
      +      "type": "boolean"
      +    },
      +    "doWriteOneTxt": {
      +      "description": "Export one TXT file per document",
      +      "type": "boolean"
      +    },
      +    "doWritePageMdXlsx": {
      +      "description": "Export page metadata to XLSX",
      +      "type": "boolean"
      +    },
      +    "doWritePdf": {
      +      "description": "Export PDF (options in pdfPars)",
      +      "type": "boolean"
      +    },
      +    "doWriteStructureInMets": {
      +      "description": "Add the logical structure to mets.xml",
      +      "type": "boolean"
      +    },
      +    "doWriteStructuresInXlsx": {
      +      "type": "boolean"
      +    },
      +    "doWriteStructuresRowBased": {
      +      "type": "boolean"
      +    },
      +    "doWriteTableSingleColumn": {
      +      "type": "boolean"
      +    },
      +    "doWriteTablesXlsx": {
      +      "description": "Export tables to XLSX",
      +      "type": "boolean"
      +    },
      +    "doWriteTagsIob": {
      +      "type": "boolean"
      +    },
      +    "doWriteTagsXlsx": {
      +      "type": "boolean"
      +    },
      +    "doWriteTei": {
      +      "description": "Export TEI (options in teiPars)",
      +      "type": "boolean"
      +    },
      +    "doWriteWordsIntoTable": {
      +      "type": "boolean"
      +    },
      +    "exportTranscriptMetadata": {
      +      "type": "boolean"
      +    },
      +    "fileNamePattern": {
      +      "type": "string"
      +    },
      +    "filterHiddenPages": {
      +      "type": "boolean"
      +    },
      +    "font": {
      +      "description": "Font of the text in PDF exports",
      +      "type": "string"
      +    },
      +    "hideUser": {
      +      "description": "How the uploader is anonymized in exported metadata",
      +      "enum": [
      +        "NULL",
      +        "NA",
      +        "HIDDEN"
      +      ],
      +      "type": "string"
      +    },
      +    "remoteImgQuality": {
      +      "description": "Which image derivative to export",
      +      "enum": [
      +        "orig",
      +        "browser",
      +        "view",
      +        "thumb",
      +        "scale50",
      +        "scale25",
      +        "bin"
      +      ],
      +      "type": "string"
      +    },
      +    "selectedTags": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "splitIntoWordsInAltoXml": {
      +      "type": "boolean"
      +    },
      +    "store2019PageXml": {
      +      "type": "boolean"
      +    },
      +    "storeValidPageXml": {
      +      "type": "boolean"
      +    },
      +    "structureTagNames": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "tableColumn": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "updatePageXmlImageDimensions": {
      +      "type": "boolean"
      +    },
      +    "useVersionStatus": {
      +      "description": "Transcript version to export, e.g. \"Latest\"",
      +      "type": "string"
      +    },
      +    "writeTextOnWordLevel": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / doBlackening
      Removed value: -{
      -  "default": false,
      -  "description": "Apply blackening",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doCreateTitle
      Removed value: -{
      -  "default": false,
      -  "description": "Create title page",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxExpandAbbrevs
      Removed value: -{
      -  "default": false,
      -  "description": "Expand abbreviations in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxForcePageBreaks
      Removed value: -{
      -  "default": false,
      -  "description": "Force page breaks in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxKeepAbbrevs
      Removed value: -{
      -  "default": false,
      -  "description": "Keep abbreviations in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxMarkUnclear
      Removed value: -{
      -  "default": false,
      -  "description": "Mark unclear text in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxPreserveLineBreaks
      Removed value: -{
      -  "default": false,
      -  "description": "Preserve line breaks in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxSubstituteAbbrevs
      Removed value: -{
      -  "default": false,
      -  "description": "Substitute abbreviations in DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doDocxWithTags
      Removed value: -{
      -  "default": false,
      -  "description": "DOCX with tags",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doExportAltoXml
      Removed value: -{
      -  "default": true,
      -  "description": "Export ALTO XML",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doExportPageXml
      Removed value: -{
      -  "default": true,
      -  "description": "Export PAGE XML",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doPdfImagesOnly
      Removed value: -{
      -  "default": false,
      -  "description": "PDF with images only",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doPdfImagesPlusText
      Removed value: -{
      -  "default": false,
      -  "description": "PDF with images plus text",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doPdfWithTags
      Removed value: -{
      -  "default": false,
      -  "description": "PDF with tags",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doPdfWithTextPages
      Removed value: -{
      -  "default": false,
      -  "description": "PDF with text pages",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doSingleClassColorTei
      Removed value: -{
      -  "default": false,
      -  "description": "Single class color TEI",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithLineBreaks
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with line breaks",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithLineTags
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with line tags",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithNoZones
      Removed value: -{
      -  "default": false,
      -  "description": "TEI without zones",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithZonePerLine
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with zone per line",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithZonePerRegion
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with zone per region",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithZonePerWord
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with zone per word",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doTeiWithZones
      Removed value: -{
      -  "default": false,
      -  "description": "TEI with zones",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWordBased
      Removed value: -{
      -  "default": false,
      -  "description": "Word-based export",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteDocx
      Removed value: -{
      -  "default": false,
      -  "description": "Write DOCX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteImages
      Removed value: -{
      -  "default": true,
      -  "description": "Write image files",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteMets
      Removed value: -{
      -  "default": true,
      -  "description": "Write METS file",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWritePdf
      Removed value: -{
      -  "default": false,
      -  "description": "Write PDF",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteTablesXlsx
      Removed value: -{
      -  "default": false,
      -  "description": "Write tables XLSX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteTagsXlsx
      Removed value: -{
      -  "default": false,
      -  "description": "Write tags XLSX",
      -  "type": "boolean"
      -}
    • removedInput schema / properties / doWriteTei
      Removed value: -{
      -  "default": false,
      -  "description": "Write TEI",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / docxPars
      Added value: +{
      +  "description": "DOCX options",
      +  "properties": {
      +    "doDocxExpandAbbrevs": {
      +      "type": "boolean"
      +    },
      +    "doDocxForcePageBreaks": {
      +      "type": "boolean"
      +    },
      +    "doDocxIgnoreSuppliedTag": {
      +      "type": "boolean"
      +    },
      +    "doDocxKeepAbbrevs": {
      +      "type": "boolean"
      +    },
      +    "doDocxMarkUnclear": {
      +      "type": "boolean"
      +    },
      +    "doDocxPreserveLineBreaks": {
      +      "type": "boolean"
      +    },
      +    "doDocxShowSuppliedTagWithBrackets": {
      +      "type": "boolean"
      +    },
      +    "doDocxSubstituteAbbrevs": {
      +      "type": "boolean"
      +    },
      +    "doDocxWithTags": {
      +      "type": "boolean"
      +    },
      +    "doDocxWriteFilenames": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / format
      Removed value: -{
      -  "description": "Export format",
      -  "type": "string"
      -}
    • changedInput schema / properties / pages / description
      Previous value: -"Page range to export (e.g. \"1-5\")"New value: +"Page range to export, e.g. \"1-5,8\"; all pages when omitted"
    • addedInput schema / properties / pdfPars
      Added value: +{
      +  "description": "PDF options",
      +  "properties": {
      +    "compressionLevel": {
      +      "description": "Stream compression and JPEG quality: 0 = fastest, 9 = smallest, -1 = default",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "defaultLineHeight": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "doPdfA": {
      +      "type": "boolean"
      +    },
      +    "doPdfImagesOnly": {
      +      "type": "boolean"
      +    },
      +    "doPdfImagesPlusText": {
      +      "type": "boolean"
      +    },
      +    "doPdfTableStructure": {
      +      "type": "boolean"
      +    },
      +    "doPdfWithArticles": {
      +      "type": "boolean"
      +    },
      +    "doPdfWithTags": {
      +      "type": "boolean"
      +    },
      +    "doPdfWithTextPages": {
      +      "type": "boolean"
      +    },
      +    "doSinglePagePdfs": {
      +      "type": "boolean"
      +    },
      +    "doTableCellBorders": {
      +      "type": "boolean"
      +    },
      +    "doTagHighlightsInText": {
      +      "type": "boolean"
      +    },
      +    "doTagHighlightsOnImage": {
      +      "type": "boolean"
      +    },
      +    "doTagLegendPage": {
      +      "type": "boolean"
      +    },
      +    "doUseLinePolygons": {
      +      "type": "boolean"
      +    },
      +    "fullCompression": {
      +      "type": "boolean"
      +    },
      +    "imgMaxDpi": {
      +      "description": "Downscale embedded images to this DPI; 0 = off",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "isAddImagePages": {
      +      "type": "boolean"
      +    },
      +    "pageNumberPosition": {
      +      "description": "Page number position, e.g. \"BC\" (bottom center); empty = none",
      +      "type": "string"
      +    },
      +    "pdfImgQuality": {
      +      "enum": [
      +        "orig",
      +        "browser",
      +        "view",
      +        "thumb",
      +        "scale50",
      +        "scale25",
      +        "bin"
      +      ],
      +      "type": "string"
      +    },
      +    "textPageLayout": {
      +      "enum": [
      +        "legacy",
      +        "compact"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / splitIntoWordsInAltoXml
      Removed value: -{
      -  "default": true,
      -  "description": "Split into words in ALTO XML",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / teiPars
      Added value: +{
      +  "description": "TEI options",
      +  "properties": {
      +    "boundingBoxCoords": {
      +      "type": "boolean"
      +    },
      +    "combineContinuedTags": {
      +      "type": "boolean"
      +    },
      +    "exportPredefinedTagsAndAttsInTei": {
      +      "type": "boolean"
      +    },
      +    "lineBreakAtBeginningOfLine": {
      +      "type": "boolean"
      +    },
      +    "lineXmlIds": {
      +      "type": "boolean"
      +    },
      +    "lineZones": {
      +      "type": "boolean"
      +    },
      +    "linebreakType": {
      +      "type": "string"
      +    },
      +    "pbImageNameAsXmlId": {
      +      "type": "boolean"
      +    },
      +    "regionZones": {
      +      "type": "boolean"
      +    },
      +    "tokenizeWhitespace": {
      +      "type": "boolean"
      +    },
      +    "useAbElements": {
      +      "type": "boolean"
      +    },
      +    "useBoundingRects": {
      +      "type": "boolean"
      +    },
      +    "useRsTags": {
      +      "type": "boolean"
      +    },
      +    "useWordCoordinates": {
      +      "type": "boolean"
      +    },
      +    "useXslTransformation": {
      +      "description": "Build the TEI with the page2tei XSL transformation",
      +      "type": "boolean"
      +    },
      +    "withoutTextline": {
      +      "type": "boolean"
      +    },
      +    "wordZones": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • removedInput schema / properties / useVersionStatus
      Removed value: -{
      -  "default": "Latest",
      -  "description": "Version status to use",
      -  "type": "string"
      -}
  2. Addedv3.1.0
  3. Removedv3.0.0
  4. First observedv2.1.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare non-read-only, non-destructive, non-idempotent and open-world behavior, so the safety profile is covered. The description adds one useful behavioral fact - that this starts a job rather than returning content synchronously - but says nothing about what the job handle looks like, how completion is checked, or permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the action and followed immediately by the configuration routing. No filler or redundant restatement.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with eight parameters and deeply nested option objects and no output schema, the definition should explain what starting a job yields and how results are retrieved. It covers configuration routing adequately but leaves the async lifecycle and return value entirely unaddressed.

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 description coverage is 100%, so the schema already documents every parameter, including the "options in pdfPars" style hints. The description's grouping of format flags versus format-specific option objects is a helpful mental model but largely repeats what the schema already encodes, so baseline 3 is right.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Start an export job for a document" gives a specific verb plus resource and scopes it to a document, which implicitly separates it from the collection-level sibling. It does not explicitly name or contrast with transkribus_coll_export, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description tells how to configure the call (formats in commonPars, per-format options in altoPars/pdfPars/teiPars/docxPars) but never states when to use this versus alternatives such as transkribus_coll_export or the document-content getters. Usage is only implied by the tool's purpose.

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

Deploy Server

Other Tools