Skip to main content
Glama
transkribus-mcp-server

transkribus-mcp-server

by lazyants

Get Validation Data Documents

transkribus_model_get_validation_data_docs
Read-onlyIdempotent

Retrieve the documents used as validation data for a Transkribus model. Provide model family, ID, and optional index/count to page through results.

Instructions

Get the documents used as validation 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_validation_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.1/5.0
Behavior2/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false, so the safety profile is covered. The description adds no behavioral context beyond the basic purpose, such as pagination behavior, return format, or any constraints on the validation data retrieval.

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?

The description is a single, front-loaded sentence with no unnecessary wording. It states the action and resource immediately, making it easy to parse.

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 read-only list tool with four parameters and no output schema, the description is minimally adequate but lacks details about what the returned documents contain or how pagination works. The annotations cover safety, but the description could do more to explain the result set and usage context.

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 all four parameters (type, id, index, nValues) are already documented in the input schema. The description does not add any meaning beyond what the schema provides, which is the baseline expectation when schema coverage is complete.

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 states a specific verb ('Get') and resource ('documents used as validation data for a model'), making the core purpose clear. It does not explicitly differentiate this tool from close siblings such as transkribus_model_get_validation_data or transkribus_doc_get_validation_data, so an agent must infer the distinction from the name alone.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives, nor does it state any prerequisites or exclusions. The intended use is only implied by the purpose statement, leaving the agent to infer selection criteria from sibling names.

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