Skip to main content
Glama

listDocuments

List vault documents filtered by path prefix, tag, or pinned status, newest first, with bodies omitted for lightweight results; fetch full content separately.

Instructions

List vault documents, most-recently-updated first, filtered by pathPrefix, tag, and/or pinned. Bodies are omitted to stay lightweight; call readDocument for one document's full body and edges.

Input Schema

NameRequiredDescriptionDefault
tagNoRestrict to documents whose frontmatter tags include this value.
limitNoMax documents to return (default 50).
pinnedNoWhen true, only pinned documents.
pathPrefixNoRestrict to documents whose path starts with this prefix, e.g. notes/.

Output Schema

NameRequiredDescriptionDefault
documentsYesMatching documents, most-recently-updated first. Bodies are omitted; call readDocument for the full body.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description still discloses two meaningful traits: results are sorted by recency, and bodies are omitted to keep responses lightweight. It does not discuss pagination behavior or what happens when limit is exceeded, but with an output schema present that burden is partly absorbed elsewhere.

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 sentences, both load-bearing: the first defines scope and ordering, the second defines what is returned and where to go for more. No filler and the key scoping constraint is front-loaded.

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 four-param optional-filter list tool with a 100%-covered schema and an output schema, this covers scope, ordering, and payload shape. The only gap is pagination/limit interaction, which the schema's defaults and maximum largely cover.

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 each parameter's meaning is already documented. The description adds only that filters are optional and combinable ('and/or'), which is marginal value on top of an already complete schema.

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 (list vault documents) plus the ordering guarantee (most-recently-updated first) and the filter set. It also names the sibling readDocument, so an agent can tell listing apart from fetching a single document 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?

Explicitly routes the agent: use this to enumerate, call readDocument when a full body and edges are needed. That is a clear when-to-use plus named alternative, though it gives no guidance on when this tool is the wrong choice versus query/recall-style siblings.

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