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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_docs"
  }
}

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.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds only the notion of permission scoping ('accessible Docs') beyond that, and says nothing about pagination behaviour or result volume, though those are handled by the schema.

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?

Two short sentences, zero filler, with the scope and filters stated first and the follow-up workflow hint second. Nothing could be removed without losing information.

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 and a fully documented five-parameter schema (cursor, limit, ordering, query, projectId) carry the mechanical details, so the description only needs scope and routing. It covers scope and points to get_doc, but does not mention that results are paginated or that filter/order must be kept stable while paging, leaving that entirely to the schema.

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

Parameters4/5

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

Schema description coverage is 100% so the baseline is 3, and the description adds a modest amount on top by naming the two filterable dimensions (project and title), which correspond to projectId and query. The 'title' wording is loosely aligned with the schema's broader 'Search text' meaning, but the schema clarifies that list tools filter names/titles, so there is no real conflict.

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 supported filter dimensions (project and title), which is enough to distinguish it from write tools like create_doc or edit_doc_content. It stops short of contrasting with the sibling list/search tools (search, list_files), so it does not reach 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 Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The second sentence gives a concrete workflow rule — read a Doc with get_doc before editing its contents — which is genuine usage guidance pointing at a named sibling. However, there is no guidance on when to use this list tool versus search or the other list_* tools, and no note on required prerequisites.

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.