Skip to main content
Glama

List documents

ragdown_list
Read-only

Browse documents with metadata like path, title, tags, and author. Filter by subfolder, tag, writer, or session, and sort by recent changes to find notes quickly.

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.

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. 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"
      +}
  2. Addedv5.9.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds substantial behavioral detail beyond annotations: one line per document, exact fields returned (path, title, tags, last change, author, session, frontmatter description), and what 'recent' sorting does. This is valuable given no output schema exists.

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?

The description is a single tight paragraph front-loaded with purpose and usage contrast, followed by return format, optional filters, and sort behavior. Every sentence carries information; nothing is wasted.

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

Completeness5/5

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

With no output schema, the description thoroughly explains the return shape (one line per document and which fields appear). It covers filtering options, sorting semantics, and the safe-read nature is covered by annotations. The only minor gap is limit/pagination, which the schema already constrains.

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 67%. The description accounts for five of six parameters (tag, path_prefix, written_by, session_id, sort) and clarifies sort='recent' behavior that the schema's bare enum does not explain. It omits 'limit' entirely, and adds little beyond the schema for parameters that already have descriptions, so it is good but not exhaustive.

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 states a specific verb and resource ('Browse the documents') and immediately distinguishes it from search. It also lists the exact return format, so an agent knows this is a listing tool, not a retrieval or search tool.

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?

The opening 'Browse the documents rather than search them' gives clear when-to-use context and implies a search alternative, but it does not name a specific sibling tool or state explicit exclusions. The optional filters are framed as conditions, which helps selection.

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