Skip to main content
Glama

List documents

ragdown_list
Read-only

Lists documents with path, title, tags, author, and last change, optionally filtered by subfolder, tag, writer, or session. Browse a local Markdown collection by metadata instead of searching it.

Instructions

Browse the documents rather than search them. Returns one line per document: its path, title, tags and last change, who wrote it and in which session when an agent did, and its description when its frontmatter has one. Optionally under a subfolder, with a tag, by who wrote it, or from one session. sort: 'recent' puts the most recently changed first.

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": "ragdown_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagNoOnly documents with this tag; 'project' also matches 'project/alpha'
sortNopath
limitNo
session_idNoOnly documents written in this conversation, as ragdown_remember recorded it
written_byNoOnly documents an agent wrote ('agent': frontmatter has created_by) or only the user's own ('user')
path_prefixNoOnly documents under this subfolder, relative to the documents root, e.g. 'projects/'

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv6.10.0
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Changed4 schema fields changedv5.16.0
    • changedInput schema / properties / path_prefix / description
      Previous value: -"Only notes under this subfolder, relative to the notes root, e.g. 'projects/'"New value: +"Only documents under this subfolder, relative to the documents root, e.g. 'projects/'"
    • addedInput schema / properties / session_id
      Added value: +{
      +  "description": "Only documents written in this conversation, as ragdown_remember recorded it",
      +  "type": "string"
      +}
    • changedInput schema / properties / tag / description
      Previous value: -"Only notes with this tag; 'project' also matches 'project/alpha'"New value: +"Only documents with this tag; 'project' also matches 'project/alpha'"
    • addedInput schema / properties / written_by
      Added value: +{
      +  "description": "Only documents an agent wrote ('agent': frontmatter has created_by) or only the user's own ('user')",
      +  "enum": [
      +    "agent",
      +    "user"
      +  ],
      +  "type": "string"
      +}
  3. Addedv5.9.0

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description does add real value beyond them by describing the per-document line (path, title, tags, last change, writer and session, frontmatter description), which substitutes for the missing output schema. It says nothing about truncation, ordering ties, or what happens when no documents match, and the sort note is the only ordering behavior disclosed.

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?

Purpose is front-loaded in the first clause, followed by return shape, then filters, then sort — a sensible information order. Every sentence carries distinct content and there is no restating of the tool name or padding.

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 six-parameter read-only listing tool with no output schema, the description covers purpose, return fields, filters, and ordering, which is most of what an agent needs. The remaining gap is limit/truncation behavior — whether a result set is capped, whether the agent can tell results were clipped — which matters given a 100 default and 1000 maximum.

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?

With 67% schema coverage, the description usefully compensates on the one undocumented behavior that matters: sort='recent' is explained as most-recently-changed-first, a semantic the bare enum does not convey. The filter parameters are restated in prose but add no detail beyond the schema's own descriptions (e.g. tag's 'project' matching 'project/alpha' is left to the schema), and limit's cap/truncation semantics remain unaddressed.

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?

The description opens with a specific verb and resource ('Browse the documents') and immediately distinguishes it from the search-style siblings ('rather than search them'), then enumerates the per-document return fields. An agent can tell this is enumeration, not retrieval or search, without opening the 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?

It gives a clear selection rule — use this to browse rather than to search — and names the filter dimensions (subfolder, tag, writer, session) that make browsing viable. It stops short of naming a concrete alternative tool or stating when browsing is a bad choice, so it falls one step shy of full routing guidance.

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