Documentation Index
Fetch the complete documentation index at: https://mintlify.com/tobi/qmd/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The status tool reports the current state of the QMD index:
- Total document count
- Embedding status (for vector search)
- Collection details
- Health indicators
No parameters required. Call with an empty object:
Array with a single text element containing a human-readable summary
Summary like:QMD Index Status:
Total documents: 1234
Needs embedding: 0
Vector index: yes
Collections: 3
- /home/user/notes (450 docs)
- /home/user/docs (300 docs)
- /home/user/journals (484 docs)
Machine-readable status details
Total number of indexed documents across all collections
Number of documents without embeddings. Run qmd embed if > 0.
Whether vector search is available. false means qmd embed has never been run.
Array of collection objects
Collection name (from qmd collection add --name)
Absolute filesystem path to collection root
Glob pattern for indexed files (e.g., **/*.md)
Number of documents in this collection
ISO 8601 timestamp of last index update
Example
Request:
Response:
{
"content": [
{
"type": "text",
"text": "QMD Index Status:\n Total documents: 1234\n Needs embedding: 0\n Vector index: yes\n Collections: 3\n - /home/user/notes (450 docs)\n - /home/user/docs (300 docs)\n - /home/user/journals (484 docs)"
}
],
"structuredContent": {
"totalDocuments": 1234,
"needsEmbedding": 0,
"hasVectorIndex": true,
"collections": [
{
"name": "notes",
"path": "/home/user/notes",
"pattern": "**/*.md",
"documents": 450,
"lastUpdated": "2025-05-15T14:23:10.000Z"
},
{
"name": "docs",
"path": "/home/user/docs",
"pattern": "**/*.md",
"documents": 300,
"lastUpdated": "2025-05-15T14:23:10.000Z"
},
{
"name": "journals",
"path": "/home/user/journals",
"pattern": "**/*.md",
"documents": 484,
"lastUpdated": "2025-05-15T14:23:10.000Z"
}
]
}
}
Use Cases
Check if Embeddings are Available
Before using vec or hyde search:
Check hasVectorIndex in the response. If false, vector search will fail. Run:
Verify Index is Up-to-Date
Check needsEmbedding count. If > 0, run:
to generate embeddings for new documents.
List All Collections
Use structuredContent.collections to see all indexed collections and their document counts.
Debugging Search Issues
If search returns no results:
- Check
totalDocuments — is the index populated?
- Check
collections — is the expected collection present?
- Check
hasVectorIndex — are you using vec/hyde without embeddings?
CLI Equivalent
Outputs the same information in a formatted table.
query Tool
Search the index after verifying status
Embeddings
Learn how to generate embeddings
Collections
Manage collections via CLI
