Skip to main content
Glama

List documents

glpi_list_documents
Read-onlyIdempotent

List documents with optional pagination.

Input Schema

NameRequiredDescriptionDefault
rangeNoPagination range, e.g. 0-49
fieldsNoField set: 'essential' (default, trims internal GLPI fields) or 'all'
formatNoOutput format: 'json' (default) or 'markdown' (a table for listings, key/value lines for one item; returned in both the text and the structured result)

Output Schema

NameRequiredDescriptionDefault
dataNo
noteNoPagination hint: how to fetch the next page
countNoItems in this page
formatNo'markdown' when data holds the markdown rendering

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and openWorldHint, so the safety profile is fully covered by structured data. The description contributes only 'optional pagination', which is already implied by the range parameter in the schema, adding essentially no behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short, front-loaded sentence with no filler. It is efficient, though its brevity comes at the cost of useful scope and routing information.

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?

An output schema exists, so return-shape explanation is not required, and the schema fully covers parameters. However, for a listing tool among many *_list_* siblings, the description omits what is being listed (documents in what scope) and how it relates to get/search, leaving it minimally adequate.

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% and all three parameters (range, fields, format) are documented with enums and examples in the schema. The description's mention of 'optional pagination' merely restates the range parameter, so the baseline 3 applies.

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?

States a specific verb and resource ('List documents'), which distinguishes it from the singular glpi_get_document and the related glpi_list_document_items. It does not explicitly name those siblings or state scope, so it falls short of a 5.

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 gives no indication of when to use this tool versus glpi_get_document, glpi_search, or glpi_list_document_items, and no prerequisites or exclusions. Usage is only implied by the name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.