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

mcp-paperless-ngx

by tobee89
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Create correspondent

create_correspondent

Create a new correspondent in Paperless-ngx. Avoid duplicates by listing existing correspondents first.

Instructions

Create a new correspondent. Check list_correspondents first: near-duplicate entries are hard to merge later.

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

Input Schema

NameRequiredDescriptionDefault
nameYesDisplay name. Must be unique.
matchNoText this object matches against, interpreted per matching_algorithm.
ownerNoOwning user ID, or null for unowned.
is_insensitiveNoCase-insensitive matching. Defaults to true.
set_permissionsNoObject-level permissions. Overwrites existing permissions entirely unless the endpoint supports merging.
matching_algorithmNoMatching algorithm: 0=none, 1=any word, 2=all words, 3=exact, 4=regex, 5=fuzzy, 6=auto. Use 6 (auto) unless the user asked for a specific rule.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already convey that this is a non-read-only, non-idempotent, non-destructive create operation. The description adds the practical risk of near-duplicates being hard to merge, which is helpful operational context, but it does not disclose error behavior, permission side effects, or return values. This is a fair extension of the annotations rather than a contradiction.

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 sentences with no filler. The first sentence states the core action minimally, and the second provides a high-value operational warning without redundancy.

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 six parameters, nested permission objects, and no output schema, the description plus the richly documented schema is sufficient for correct invocation. The duplicate warning is important. It would be a 5 if it also described the returned object or duplicate-name error behavior.

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 schema already documents parameters like match, owner, is_insensitive, set_permissions, and matching_algorithm. The description adds no parameter-level detail, so the baseline of 3 is appropriate.

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 states a clear action and resource: 'Create a new correspondent.' It also positions the tool against its sibling CRUD operations by instructing the agent to check list_correspondents first, making the creation entry point unmistakable.

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

Usage Guidelines4/5

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

The description explicitly tells the agent to run list_correspondents before creating and explains why: 'near-duplicate entries are hard to merge later.' This is useful when-to-use guidance, though it stops short of explicitly saying to use update_correspondent when a matching entry already exists.

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