Skip to main content
Glama
Sign In
paperless-mcp

paperless-mcp

by chiefmikey
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

search_documents

Search Paperless-ngx documents by full-text query. Returns summaries with document IDs.

Instructions

Search Paperless-ngx documents by full-text query, returns summaries with IDs

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": {
      "query": "<query>"
    },
    "name": "search_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number for paginated results (default: 1)
queryYesFull-text search query string

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description partially carries the behavioral burden. It states 'returns summaries with IDs', indicating a read operation, but does not disclose pagination behavior (despite the page parameter in schema), rate limits, or outcomes like empty result handling.

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 sentence, no redundant words, and directly states the purpose and output. It is concise and front-loaded.

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

Completeness3/5

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

For a simple search tool with 2 parameters and no output schema, the description is somewhat complete but lacks details on pagination, error conditions, or result format beyond 'summaries with IDs'. It is adequate but could be more informative.

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% with both parameters described. The description adds minimal value beyond schema, only hinting at output (summaries with IDs). Baseline 3 is appropriate as schema already documents parameters adequately.

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 verb 'Search', the resource 'Paperless-ngx documents', the method 'full-text query', and the output 'returns summaries with IDs'. This distinguishes it from sibling tools like get_document (single document retrieval) and list_* tools (listing entities).

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 usage for full-text search but provides no explicit guidance on when to use this tool versus alternatives (e.g., get_document for specific document, list_* for enumerations). No 'when not to use' or prerequisite conditions are mentioned.

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