Skip to main content
Glama
pvliesdonk
by pvliesdonk

Upload Document

upload_document

Upload a document to Paperless-NGX with optional title, tags, correspondent, and custom fields. Returns a task UUID to track processing status via get_task.

Instructions

Upload a document. Returns the task UUID for polling via get_task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNo
titleNo
createdNo
filenameYes
correspondentNo
custom_fieldsNo
document_typeNo
content_base64Yes
archive_serial_numberNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
task_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.3/5.0
Behavior4/5

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

The description discloses that the operation is asynchronous by returning a task UUID for polling via get_task. This is a critical behavioral trait not covered by the annotations (which only indicate it is not read-only). It adds useful context about the operation's non-blocking nature.

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 extremely concise: two short sentences that immediately state the action and the key return behavior. Every word earns its place, with no filler or redundant information.

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

Completeness2/5

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

Given the tool has 9 parameters and no schema descriptions, the description is highly incomplete. It omits any explanation of parameter meanings, prerequisites, or how the polling process works beyond mentioning the task UUID. It fails to equip an agent to use the tool correctly without additional external knowledge.

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

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description must compensate for parameter meaning, but it provides none. It does not mention any of the 9 parameters, leaving the agent with no semantic guidance for required fields like filename and content_base64 or optional ones like tags and title.

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

Purpose5/5

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

The description clearly states the action 'Upload' and the resource 'document', and mentions the return of a task UUID for polling, which differentiates it from read-only tools like list_documents or get_document. It is specific and unambiguous.

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?

There is no guidance on when to use this tool versus alternatives. It does not mention that it is for creating new documents, nor does it exclude any scenarios or mention prerequisites. The description simply states 'Upload a document' without any context for selection.

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