list_documents
Browse indexed documents one page at a time, optionally filtered by category, to inspect filepaths, categories, and metadata without side effects.
Instructions
List indexed documents one page at a time, optionally filtered by category.
Read-only. No side effects.
Args: category: Optional category filter, matched exactly against each document's category; an empty string, like omitting it, lists every document, and a category without documents returns an empty page (total 0). Call list_categories() to see the categories that hold documents. limit: Maximum number of documents to return (default: 100, max: 200). offset: Number of matching documents to skip (default: 0). For the next page, call again with offset + count until offset reaches total.
Returns: JSON string with total (documents matching the filter), offset, limit, count (documents in this page) and the filepaths, categories, and metadata of this page, ordered by filepath.
Usage: Use to browse what's in the index, one page at a time; to see every document, call again with offset + count until offset reaches total. Use list_categories() first to see which categories hold documents. Use search_knowledge() when you want to find documents by topic rather than browsing the full list. Use get_document() to read a specific file once you have its filepath.
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": "list_documents"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| category | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |