Skip to main content
Glama

list_docs

Lists project documentation in reading order with IDs, kinds, titles, sizes, and change times; filter by kind, then read a document with get_doc.

Instructions

The project's docs in reading order (starting prompt, spec, plan, AGENTS.md, memory, notes, working docs): id, kind, title, size, when changed. No bodies: read one with get_doc. kind narrows the list. Docs marked global (the AGENTS.md and the memory for all projects) belong to every project: read them too, they hold the user's standing rules.

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
kindNo
projectNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does disclose the key traits: it is a metadata-only read (no bodies), results come in reading order, and global AGENTS.md/memory docs cross project boundaries. It omits pagination/limits and what happens for an unknown project, which keeps it short of a 5.

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?

Front-loads the purpose and ordering, then the returned fields, then the get_doc pointer, then the kind and global rules. Every clause carries information; nothing is filler.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Output schema exists, so return values need not be spelled out, and the read-only framing is adequate. However, for a 0%-coverage two-parameter tool, the unaddressed `project` parameter and undocumented set of valid `kind` values leave real gaps an agent must guess at.

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 0%, so the description must carry parameter meaning. It explains that `kind` narrows the list, but never enumerates valid kinds (no enum in the schema) and never mentions the `project` parameter at all, leaving half the input surface unexplained.

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?

States a specific verb and resource (lists the project's docs) plus the exact reading order, returned fields (id, kind, title, size, when changed), and explicitly excludes bodies by pointing to get_doc. An agent can distinguish it from get_doc and read without opening either schema.

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?

Gives a clear when-not ('No bodies: read one with get_doc') and a scoping rule for `global` docs that belong to every project. The one soft spot is that 'read them too' leaves ambiguous whether global docs come back in this listing or need read_global_docs, so the alternative routing is slightly blurred.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.