Skip to main content
Glama

Create a tag, correspondent or type

paperless_create_object

Create tags, correspondents, document types, storage paths, or custom fields in paperless-ngx. Configure matching algorithm, colors, paths, or data types for automated document classification.

Instructions

Create a tag, correspondent, document type, storage path or custom field. Matching algorithm: 0 none, 1 any word, 2 all words, 3 exact, 4 regex, 5 fuzzy, 6 auto (trained classifier). Storage paths need a path template such as {{ created_year }}/{{ correspondent }}/{{ title }}. Custom fields need a data_type (string, url, date, boolean, integer, float, monetary, documentlink, select).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesName of the new object.
pathNoStorage paths only: the filename template.
typeYesWhat to create.
matchNoMatch text or pattern used for automatic assignment.
colourNoTags only: hex colour such as `#a6cee3`.
data_typeNoCustom fields only: the value type.
extra_dataNoCustom fields only, e.g. `{"select_options":[{"label":"Cat"},{"label":"Dog"}]}`.
is_inbox_tagNoTags only: mark newly consumed documents with this tag.
is_insensitiveNoCase-insensitive matching. Defaults to true server-side.
matching_algorithmNoMatching algorithm: 0 none, 1 any word, 2 all words, 3 exact, 4 regex, 5 fuzzy, 6 auto (trained classifier).
Behavior3/5

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

Annotations already indicate this is not read-only and not destructive. The description adds relevant domain context: matching algorithm values, storage path template requirements, and custom field data types. It does not disclose return values, validation behavior, or permission needs, but the annotation safety profile lowers the burden.

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?

The description is compact and front-loaded with the core purpose, followed by concise type-specific notes. It loses a point because the full matching algorithm list largely duplicates the schema's existing description, and the title's 'type' is slightly ambiguous compared to the fuller description.

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

Completeness4/5

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

For a creation tool with 10 parameters and several type-specific constraints, the description supplies the important cross-cutting requirements: storage paths need a path template and custom fields need a data_type. Combined with the rich schema containing per-parameter descriptions and enums, the agent has enough information to invoke the tool correctly.

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 baseline is 3. The description repeats the matching algorithm enum and data_type values that are already in the schema, while adding only a storage path template example. This adds slight value but does not meaningfully compensate beyond what the schema already provides.

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 names a specific verb ('Create') and enumerates the exact resources: tag, correspondent, document type, storage path, or custom field. This clearly differentiates it from sibling tools like paperless_update_object, paperless_delete_objects, and paperless_list_objects, even without explicit cross-references.

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 implies the usage case by saying 'Create a tag...' and adds helpful type-specific conditions, such as storage paths needing a `path` and custom fields needing `data_type`. However, it does not explicitly state when not to use the tool or point to alternatives like paperless_update_object for modifications, leaving some routing to inference.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/patrickcylai/paperless-ngx-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server