Skip to main content
Glama

List Documents

list_documents
Read-onlyIdempotent

List documents created by the user or shared within the account.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax documents to return (max 50, default 10)
offsetNoNumber of items to skip for pagination (default 0)

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 covered. The description adds scope context (owned or shared documents), but does not disclose anything further such as pagination behavior or whether drafts are included.

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, efficient sentence with no redundant wording. It front-loads the verb and resource, and every word contributes to comprehension.

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?

For a simple read-only list tool with two documented parameters and covered annotations, the description is nearly sufficient. It lacks explicit clarification about whether drafts are excluded (given there is a separate list_drafts tool) and does not describe the return shape, but overall it covers the essential contract.

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?

Both parameters (limit and offset) are fully documented in the input schema with descriptions, defaults, and constraints, so schema coverage is 100%. The description adds no param-level context, but it is not required given the high coverage.

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 states a specific verb ('List'), resource ('documents'), and scope ('created by the user or shared within the account'). It clearly distinguishes the tool from siblings like list_drafts, list_templates, and list_webhooks by naming the document resource.

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 retrieving all visible documents, but it does not explicitly say when to use this tool versus alternatives such as list_drafts or get_document. Since list_drafts exists as a sibling, a quick pointer or exclusion such as 'this does not include drafts' would provide valuable guidance.

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.

Resources