Skip to main content
Glama

List folder

bm_list
Read-onlyIdempotent

Lists subfolders and files in a Basic Memory project folder, including titles, dates, and IDs, with glob filtering and sorting to browse project contents.

Instructions

List one folder of a Basic Memory project: its subfolders, then its files with title, date and id. project is required; '/' lists its root. Discover projects with bm_project(command='list'). Filter files with glob and order them with sort. For a recursive search by name or frontmatter, use bm_find.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "bm_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
globNoFile-name glob, e.g. '*.md' or '*meeting*'.
pageNoPage number.
pathNoA directory in the project, e.g. 'specs' or 'specs/active'. '/' is the project root; '<project>/path' addresses another project./
sortNoFile order. Folders always come first.
projectYesRequired project name, 'workspace/project', or project external id. Discover projects with bm_project(command='list'). Paths are relative to this project; a qualified path must agree with it.
page_sizeNoResults per page (1-100).
output_formatNotext

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • removedInput schema / properties / project / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • removedInput schema / properties / project / default
      Removed value: -null
    • changedInput schema / properties / project / description
      Previous value: -"Project name, 'workspace/project', or project external id. Omit to use the default project."New value: +"Required project name, 'workspace/project', or project external id. Discover projects with bm_project(command='list'). Paths are relative to this project; a qualified path must agree with it."
    • addedInput schema / properties / project / minLength
      Added value: +1
    • addedInput schema / properties / project / type
      Added value: +"string"
    • addedInput schema / required
      Added value: +[
      +  "project"
      +]
    • changedOutput schema / properties / result / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": true,
      -    "type": "object"
      -  },
      -  {
      -    "type": "string"
      -  }
      -]New value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "additionalProperties": true,
      +    "type": "object"
      +  }
      +]
  2. Addedv0.24.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so safety is covered. The description adds genuine context beyond them: what the listing contains, that folders always precede files, and that sorting applies only to files. It does not mention paging or that large folders are truncated at page_size, which is the one behavioral trait an agent could trip over.

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?

Four short sentences, front-loaded with the core action and output shape, then constraints, then the sibling alternative. Every clause carries information; there is no restatement of the tool name or filler.

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 an output schema present, return values need not be explained in depth, and the description still previews them. Project discovery, root addressing, filtering, ordering and the sibling alternative are all covered, which is everything needed to invoke a read-only folder lister correctly.

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 86%, so the schema already carries parameter meaning; the description reinforces that 'glob' filters files (not folders) and that 'sort' orders files only. It adds modest clarification but no format, syntax, or interaction detail (e.g. how glob and path interact) beyond the schema — baseline 3 applies.

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 one folder of a Basic Memory project') and even describes the output shape — subfolders first, then files with title, date and id. It explicitly separates itself from bm_find's recursive search, so an agent can pick between them without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

Gives the prerequisite ('project' is required), the root convention ('/' lists its root), a bootstrapping step (bm_project(command='list')), and an explicit alternative for a different use case ('For a recursive search by name or frontmatter, use bm_find'). Nothing about when to choose this tool is left to inference.

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