Skip to main content
Glama
transkribus-mcp-server

transkribus-mcp-server

by lazyants

Create Document from PDF

transkribus_coll_create_doc_from_pdf

Create a Transkribus collection document by uploading a local PDF file as multipart form data, with optional title and source deletion after ingest.

Instructions

Create a document in a collection by uploading a local PDF file as multipart form data.

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>",
      "pdfFilePath": "<pdfFilePath>"
    },
    "name": "transkribus_coll_create_doc_from_pdf"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleNoDocument title
collIdYesCollection ID
pdfFilePathYesLocal path to the PDF file
doDeleteImportSourceNoDelete import source after ingest

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv4.2.0
  2. Removedv4.0.0
  3. Addedv3.1.0
  4. Removedv3.0.0
  5. First observedv2.1.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnly=false, openWorld=true, idempotent=false and destructive=false, so the safety profile is covered. The description adds the useful detail that content is sent as multipart form data, but it does not warn that repeated calls will create duplicate documents (non-idempotent), nor whether ingestion is asynchronous or what happens on failure.

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?

A single front-loaded sentence with no filler. The verb, resource and transport mechanism all appear immediately.

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?

With no output schema, the description should tell the agent what comes back, such as a document ID or job handle, and whether processing is async; it does neither. It is otherwise adequate for a straightforward ingest call, but the post-call expectations are left unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/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 are already documented, and the description correctly ties the operation to a collection and a local PDF path. The mention of multipart form data adds a little operational meaning beyond the schema, though nothing is said about the optional title or doDeleteImportSource flags.

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?

States a specific verb and resource: 'Create a document in a collection', plus the mechanism 'uploading a local PDF file'. The 'local PDF file' detail implicitly separates it from FTP/IIIF/METS ingestion siblings, though it never names those alternatives explicitly.

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 'local PDF file' phrasing implies this is the path for file-on-disk uploads, which gives some implied routing versus the ftp/iiif/mets variants. However, there is no explicit when-to-use or when-not-to-use statement, and no sibling is named as the alternative for other source types.

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