Skip to main content
Glama
transkribus-mcp-server

transkribus-mcp-server

by lazyants

Get Training Data Documents

transkribus_model_get_train_data_docs
Read-onlyIdempotent

Retrieves the documents used as training data for a Transkribus model by model family and ID, with paging. Use it to inspect or verify which documents trained a model.

Instructions

Get the documents used as training data for a model.

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": {
      "type": "<type>",
      "id": "<id>"
    },
    "name": "transkribus_model_get_train_data_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesResource ID
typeYesModel family: text, layout or smartextract
indexNoStart index (0-based)
nValuesNoNumber of results (-1 for all)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.2.0
    • changedInput schema / properties / type / description
      Previous value: -"Model type (e.g. htr, la, ocr)"New value: +"Model family: text, layout or smartextract"
  2. Changed5 schema fields changedv4.0.0
    • addedInput schema / properties / index / default
      Added value: +0
    • changedInput schema / properties / index / description
      Previous value: -"Start index"New value: +"Start index (0-based)"
    • changedInput schema / properties / index / minimum
      Previous value: --9007199254740991New value: +0
    • addedInput schema / properties / nValues / default
      Added value: +-1
    • changedInput schema / properties / nValues / description
      Previous value: -"Number of values"New value: +"Number of results (-1 for all)"
  3. Changed1 schema field changedv3.0.0
    • addedInput schema / properties / type / pattern
      Added value: +"^[^/\\s]+$"
  4. First observedv2.1.1

TDQS

B3.4/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered without description help. The sentence adds no behavioral context of its own, such as pagination defaults, ordering, or what happens if the model has no training documents.

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

Conciseness4/5

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

A single front-loaded sentence with no filler or repetition. It is appropriately sized, though its brevity leaves the notable gaps noted in other dimensions.

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 four-parameter read tool with full schema coverage and annotations, the description covers the core intent. However, with no output schema, an agent gets no hint about the shape of the returned document list or how index/nValues affect it.

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% and the schema documents id, type (with the text/layout/smartextract family values), index, and nValues. The description contributes no additional parameter meaning, so the baseline 3 applies.

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?

The description names a specific verb+resource: documents used as training data for a model. The word "training" implicitly separates it from the sibling transkribus_model_get_validation_data_docs, though no sibling is named explicitly and no distinction from transkribus_model_get_train_data is drawn.

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?

Usage is only implied: an agent infers it should call this when it needs the document list backing a model's training set. There is no explicit when-to-use, no mention of prerequisites (e.g., that the model must already be trained or that id/type must identify a model), and no signposting to the validation-data counterpart.

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