Skip to main content
Glama

List Documents

list_documents
Read-onlyIdempotent

Search and paginate documents accessible in a workspace. Omit workspaceId for your account.

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNo
offsetNo
workspaceIdNo

Output Schema

NameRequiredDescriptionDefault
userYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is fully covered. The description adds the workspace scoping rule and the account-level fallback, which is useful, but says nothing about ordering, pagination mechanics, or result size beyond the word 'paginate'.

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?

Two short sentences, front-loaded with the core action and followed immediately by the one non-obvious scoping rule. No filler, though it is arguably too terse for a four-parameter search tool.

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

Completeness2/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-value explanation is rightly omitted. But for a search/list tool with four undocumented parameters and a name that conflicts conceptually with the `search` sibling, the description leaves the agent guessing about query semantics and pagination.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for all four parameters, and it only explains `workspaceId` (omit to scope to your account). It says nothing about what `query` matches (title, content, metadata) or about `limit`/`offset` behavior.

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 ('Search and paginate') and resource ('documents accessible in a workspace'), so the agent knows exactly what operation it performs. However, it never distinguishes itself from siblings like `search`, `get_document`, or `list_project_documents`, which is a real ambiguity given the overlap in intent.

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 only guidance is a parameter-scoping note ('Omit workspaceId for your account'). There is no statement of when to prefer this over `search` or `list_project_documents`, nor any exclusion or prerequisite.

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