Skip to main content
Glama
chiefmikey
by chiefmikey

list_correspondents

Retrieve a list of all correspondents from Paperless-ngx, including their IDs and document counts.

Instructions

List all correspondents defined in Paperless-ngx with their IDs and document counts

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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

No annotations are provided, so the description must disclose behavioral traits. It only states that the tool lists all correspondents with IDs and counts, but does not mention read-only nature, authentication needs, or any side effects. For a read operation, transparency is minimal.

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 a single, clear sentence with no unnecessary words. It is efficiently front-loaded with the action and resource.

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 no parameters, no output schema, and no annotations, the description provides sufficient context for a simple list-all operation. It does not mention pagination or limits, but for a tool with no inputs, it is likely unpaginated. The information is complete enough for an agent to use correctly.

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?

There are no parameters (schema coverage 100% for zero params). The description adds meaning by specifying that the output includes IDs and document counts, which is not evident from the empty schema. According to the baseline for zero parameters, a score of 4 is appropriate.

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

Purpose4/5

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

The description clearly states the verb 'list' and the resource 'correspondents', and specifies that IDs and document counts are included. It distinguishes the tool from siblings like 'list_document_types' and 'list_tags' by naming the specific resource, but does not contrast them directly.

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?

The description provides no guidance on when to use this tool versus alternatives like 'list_tags' or 'list_document_types'. It lacks explicit context for usage, such as prerequisites or exclusions.

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/chiefmikey/paperless-mcp'

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