`list_notes`

List the notes

Reads only

Description

What the model reads, word for word:

Lists the notes under a folder, one line per note.

Parameters

Name	Type	Description
`folder`	`string`	Only notes below this folder, relative to the vault root, for example “projects/apollo”. Leave it out for the whole vault.
`type`	`string`	Only notes whose frontmatter type is exactly this, for example “note” or “task”. A type that matches nothing is answered with the types there are.
`status`	`string`	Only notes whose frontmatter status is exactly this, for example “draft”. A status that matches nothing is answered with the ones there are.
`fields`	`string[]`	Extra frontmatter fields to show for each note, for example [“stand”, “status”]. A note without the field just leaves it out. Dates come as YYYY-MM-DD, lists joined with commas.
`limit`	`integer`	How many notes to list on this page. At least 1. At most 200. Default `50`.
`offset`	`integer`	How many notes to skip. An answer with more after it names the next offset. Default `0`.
`repo`	`"handbook" \| "projects"`	The repository this call works in. One of the repositories the person can read; the values above are Acme’s.

Result

As structuredContent and, the same, as a text block.

Field	Type	Description
`notes`	`object[]`
`notes[].path`	`string`	Path of the note, relative to the vault root.
`notes[].title`	`string`	Its title from the frontmatter, or its file name.
`notes[].type`	`string`
`notes[].summary`	`string`
`notes[].fields`	`object`
`notes[].repo`	`string`
`total`	`number`	How many notes match, across all pages.
`offset`	`number`	How many notes were skipped before this page.
`hasMore`	`boolean`	True when more notes follow after this page.
`note`	`string`
`repo`	`string`

As listed

The entry in tools/list, captured from the service for Acme’s two repositories.

{
  "name": "list_notes",
  "title": "List the notes",
  "description": "Lists the notes under a folder, one line per note.",
  "inputSchema": {
    "type": "object",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "properties": {
      "folder": {
        "description": "Only notes below this folder, relative to the vault root, for example \"projects/apollo\". Leave it out for the whole vault.",
        "type": "string"
      },
      "type": {
        "description": "Only notes whose frontmatter type is exactly this, for example \"note\" or \"task\". A type that matches nothing is answered with the types there are.",
        "type": "string",
        "minLength": 1
      },
      "status": {
        "description": "Only notes whose frontmatter status is exactly this, for example \"draft\". A status that matches nothing is answered with the ones there are.",
        "type": "string",
        "minLength": 1
      },
      "fields": {
        "description": "Extra frontmatter fields to show for each note, for example [\"stand\", \"status\"]. A note without the field just leaves it out. Dates come as YYYY-MM-DD, lists joined with commas.",
        "maxItems": 10,
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[A-Za-z_][A-Za-z0-9_-]*$"
        }
      },
      "limit": {
        "default": 50,
        "description": "How many notes to list on this page.",
        "type": "integer",
        "minimum": 1,
        "maximum": 200
      },
      "offset": {
        "default": 0,
        "description": "How many notes to skip. An answer with more after it names the next offset.",
        "type": "integer",
        "minimum": 0,
        "maximum": 9007199254740991
      },
      "repo": {
        "type": "string",
        "description": "The repository this call works in.",
        "anyOf": [
          {
            "const": "handbook",
            "description": "How Acme works: onboarding, processes and policies."
          },
          {
            "const": "projects",
            "description": "One folder per project: plans, decisions and meeting notes."
          }
        ]
      }
    }
  },
  "annotations": {
    "readOnlyHint": true,
    "openWorldHint": false
  },
  "outputSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "notes": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "path": {
              "type": "string",
              "description": "Path of the note, relative to the vault root."
            },
            "title": {
              "type": "string",
              "description": "Its title from the frontmatter, or its file name."
            },
            "type": {
              "type": "string"
            },
            "summary": {
              "type": "string"
            },
            "fields": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "string"
              }
            },
            "repo": {
              "type": "string"
            }
          },
          "required": [
            "path",
            "title"
          ],
          "additionalProperties": false
        }
      },
      "total": {
        "type": "number",
        "description": "How many notes match, across all pages."
      },
      "offset": {
        "type": "number",
        "description": "How many notes were skipped before this page."
      },
      "hasMore": {
        "type": "boolean",
        "description": "True when more notes follow after this page."
      },
      "note": {
        "type": "string"
      },
      "repo": {
        "type": "string"
      }
    },
    "required": [
      "notes",
      "total",
      "offset",
      "hasMore"
    ],
    "additionalProperties": false
  }
}

Major Vault is made by majortom.ai. The tool pages are generated from the code of this build. For agents: llms.txt, llms-full.txt.