Skip to main content
Glama
tobee89

mcp-paperless-ngx

List custom fields

list_custom_fields
Read-onlyIdempotent

Retrieve custom field definitions with IDs, data types, and document usage counts to get the identifiers needed before reading or writing custom field values on documents.

Instructions

Custom fields defined on this instance, with their IDs, data types and how many documents use them. You need the IDs before you can read or write custom field values on a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fullNoReturn every field instead of the identifying summary.
pageNo1-based page number.
orderingNoField to order by. Prefix with '-' to reverse, e.g. '-created'.
page_sizeNoItems per page. Clamped by the server's configured ceiling.
name__icontainsNoCase-insensitive substring filter on the name.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  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 establish read-only, idempotent, non-destructive behavior. The description adds that the response includes IDs, data types, and usage counts, and that IDs are a prerequisite for document field operations. It does not disclose pagination or ordering behavior, but that is minor given the annotations.

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?

Two sentences with no wasted words. The first sentence states the output and result, the second gives the practical purpose. Information is front-loaded and efficient.

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?

Covers what the tool returns and why it should be used (to obtain IDs before document field operations). Pagination and filtering are left to the fully documented schema, and while there is no output schema, the description adequately summarizes return content.

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 baseline is 3. The description adds no parameter-specific meaning beyond what the schema already documents.

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?

States it lists custom fields defined on the instance, with IDs, data types, and usage counts. This clearly differentiates it from singular get_custom_field and management tools like create/update/delete_custom_field.

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?

Explicitly tells the agent that IDs are required before reading or writing custom field values on a document, which is a clear use case. It does not explicitly name alternatives such as get_custom_field for a single field, so it falls short of full alternative routing.

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

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