Skip to main content
Glama
Sign In
mcp-paperless-ngx

mcp-paperless-ngx

by tobee89
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Create custom field

create_custom_field

Define a new custom field for document metadata. Choose its data type carefully, as it cannot be changed after creation.

Instructions

Define a new custom field. The data type cannot be changed afterwards, so pick it deliberately.

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": {
      "name": "<name>",
      "data_type": "<data_type>"
    },
    "name": "create_custom_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
data_typeYesField type. 'select' requires extra_data.select_options; 'monetary' stores a currency-prefixed amount; 'documentlink' stores references to other document IDs.
extra_dataNoType-specific configuration. For 'select': {"select_options": [{"label": "Open"}, {"label": "Paid"}]}. For 'monetary': {"default_currency": "EUR"}.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4/5.0
Behavior4/5

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

The description adds a valuable non-recoverable behavior: the data type cannot change after creation, which is not encoded in annotations or schema. Since annotations already signal that this is a mutating, non-idempotent operation, the extra permanence warning is strong added context.

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 two short sentences with no filler; the core action comes first and the critical design constraint follows immediately. Every sentence earns its place.

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?

Given the annotations and a schema that lists required parameters and extra_data examples, the description is nearly sufficient. It covers the one non-obvious constraint (type immutability), though it omits details such as return value and duplicate-name behavior, which are not critical for correct invocation.

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?

With 67% schema coverage, the schema already explains data_type and extra_data, including select/monetary requirements. The description adds meaningful semantics for data_type (immutability), but it does not explain the 'name' parameter or add details that the schema lacks for the remaining fields.

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 uses a specific verb-resource pairing ('Define a new custom field') and the word 'new' clearly distinguishes this creation action from sibling update_custom_field, get_custom_field, and delete_custom_field. There is no ambiguity about what the tool does.

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 timing is implied by 'new' and the permanence warning suggests using this tool only when a custom field with a deliberate type is needed. However, it does not explicitly name alternatives like update_custom_field or say when not to use it, so the guidance is only implicit.

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