Skip to main content
Glama
Milli42

paperlessngx-mcp

by Milli42

paperless_list_correspondents

Read-only

List all correspondents with ID, name, and document count. Optionally filter by case-insensitive name substring.

Instructions

PRIVACY TIER 1 (metadata only): List all correspondents with id, name, and document_count. Optional case-insensitive name filter.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNoOptional substring filter on correspondents name.
Behavior5/5

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

Beyond the readOnlyHint annotation, the description adds two behavioral traits: the 'metadata only' privacy disclosure and the case-insensitive filter behavior. No contradictions exist.

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: a single sentence with a prefix that adds essential privacy context. No unnecessary words or repetition.

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

Completeness5/5

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

For a simple list tool with one optional parameter and no output schema, the description fully covers the purpose, returned fields, privacy implications, and filter behavior. It leaves no significant gaps.

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?

With 100% schema coverage, the baseline is 3. The description adds the value 'case-insensitive' to the filter parameter, which is not in the schema description, providing meaningful extra context.

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 tool's action ('list all correspondents'), the specific resource, and the fields returned (id, name, document_count). It is distinct from sibling tools like paperless_list_document_types and paperless_list_tags due to the explicit resource name.

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 provides a usage context via 'PRIVACY TIER 1 (metadata only)', indicating it is safe for privacy-sensitive use. It does not explicitly mention when not to use or contrast with sibling tools like paperless_search_documents, but the context is clear enough.

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/Milli42/paperlessngx-mcp'

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