Skip to main content
Glama

ppl - Personal CRM for AI Agents

List Documents

documents.list
Read-onlyIdempotent

When the user wants to see stored documents, either overall or for one contact.

Input Schema

NameRequiredDescriptionDefault
contact_idNoOptional contact API id to filter by.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is fully covered. The description adds only scoping context and discloses nothing further such as pagination or default limits. With annotations carrying the behavioral burden, a 3 is appropriate.

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?

A single front-loaded sentence that states the trigger and scope with zero filler. Nothing could be trimmed without losing meaning.

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?

An output schema exists and annotations cover the safety profile, so return values and mutability need not be explained. The description covers when-to-use and filtering scope; only pagination/ordering behavior is left unstated, which is minor for a simple list tool.

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 coverage is 100% for the single contact_id parameter, so the schema already documents it. The description's 'either overall or for one contact' echoes the filter semantics but adds no format or syntax detail. Baseline 3 applies when the schema does the work.

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 the resource (stored documents) and its scope (overall or for one contact), so an agent can tell it apart from documents.delete and documents.upload immediately. The verb is soft ('see') rather than the explicit 'list' in the title, but the intent is unambiguous.

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?

Opens with an explicit when-to-use trigger ('When the user wants to see stored documents') and names both usage modes (overall vs. single contact). It omits any alternatives or exclusions, but for a terminal list tool with obvious siblings this is clear context.

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.