Skip to main content
Glama

List Docs

list_docs
Read-onlyIdempotent

List accessible Docs, optionally filtering by project and title. Read a Doc with get_doc before editing its contents.

Input Schema

NameRequiredDescriptionDefault
afterNoPagination cursor from the previous nextCursor. Keep filters and ordering unchanged; omit for the first page.
limitNoMaximum number of items to return, from 1 to 100. Defaults to 50.
orderNoResult ordering. Defaults to most recently updated first. Keep the same order while paging.UPDATED_DESC
queryNoSearch text. List tools filter names/titles; search queries indexed workspace content.
projectIdNoExisting accessible project ID returned by list_projects.

Output Schema

NameRequiredDescriptionDefault
itemsYesAccessible records on this page.
nextCursorYesPass as after for the next page; null when this page has no continuation cursor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and closed-world, so the safety profile is covered. The description adds only the access-scoping detail ('accessible Docs'); it says nothing about pagination behavior or result shape, though the schema documents the cursor. Modest added value on top of rich annotations.

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 compact sentences with no filler, and the core purpose is front-loaded before the workflow tip. Nothing is wasted, though the second sentence is of secondary relevance to selecting this tool.

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, so return values and pagination need not be re-explained; the description correctly covers purpose, filter scope, and the follow-up get_doc step. Only the absence of explicit when-to-use versus search leaves a small gap for a read-only listing tool with five all-optional params.

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 all five parameters (after, limit, order, query, projectId) are fully documented in the schema itself. The description's mention of 'project and title' filtering faintly echoes projectId and query but adds no syntax or semantics beyond the schema. 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 accessible Docs') plus the filter scope ('optionally filtering by project and title'), which is enough to distinguish it from get_doc and the other list_* siblings. It stops short of explicitly naming the alternative list-like tool (search), so it is clear but not maximally differentiated.

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 only routing guidance is a downstream workflow tip ('Read a Doc with get_doc before editing its contents'), which implies list->get_doc->edit but never says when to prefer this tool over search or the other list_* tools. Usage context is implied rather than stated.

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.