docsonar
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@docsonarAdd my ~/Documents/notes folder and find everything about quarterly planning."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
docsonar
Chat with your folders. A local document search MCP server — your files never leave your machine.
docsonar indexes folders of documents into a single SQLite database and gives any MCP client (Claude Desktop, Claude Code, and others) hybrid keyword + semantic search over them. Fully offline, zero configuration, read-only by design.
Quickstart
Claude Code
Add to your project's .mcp.json (or ~/.claude.json for all projects):
{
"mcpServers": {
"docsonar": {
"command": "uvx",
"args": ["docsonar"]
}
}
}Claude Desktop
Add to claude_desktop_config.json (Settings → Developer → Edit Config):
{
"mcpServers": {
"docsonar": {
"command": "uvx",
"args": ["docsonar"]
}
}
}Running from a source checkout instead: "command": "uv", "args": ["run", "--directory", "/path/to/docsonar", "docsonar"].
Then just talk to it: "Add my ~/Documents/notes folder and find everything about quarterly planning." The first index downloads the embedding model (~130 MB, one time); keyword search works immediately while that happens.
For HTTP instead of stdio: uvx docsonar --transport http --port 8365.
Related MCP server: local-document-rag-agent
Tools
Tool | Purpose |
| Register a folder; indexing starts in the background |
| Unregister and purge its index data |
| Registered folders with counts and last index time |
| Hybrid keyword+semantic search (RRF-fused); ranked passages with file path, heading/page location, and snippet |
| File text (extracted text for pdf/docx/html); refuses paths outside registered folders |
| Documents most similar in meaning to a given file |
| Incremental refresh: new/changed files reindexed, deleted files purged |
| Index totals, embedding model state, background job progress, failed files |
Supported formats: txt, md, pdf (page-aware, cites p. 12), docx, html.
Architecture
flowchart LR
Client["MCP client<br/>(Claude Desktop / Code)"] <-->|stdio or HTTP| Server["FastMCP server<br/>8 tools"]
Server --> Sec["path security<br/>(registered folders only)"]
Server --> Search["hybrid search<br/>BM25 + cosine KNN + RRF"]
Server --> Worker["background indexer<br/>(worker thread + queue)"]
Worker --> Parsers["parsers<br/>txt · md · pdf · docx · html"]
Parsers --> Chunker["heading/page-aware chunker<br/>~400 tokens, 60 overlap"]
Chunker --> DB[("SQLite<br/>FTS5 + sqlite-vec")]
Search --> DB
Embed["sentence-transformers<br/>bge-small-en-v1.5 (local)"] --> Worker
Embed --> SearchEvery chunk stores its location (heading path like Setup > Windows, or PDF page range), so search results can cite report.pdf, p. 12.
Design decisions
Read-only by design. There are no write, move, or delete tools, and there never will be. The server only reads files inside folders you explicitly register — with symlink-escape protection and strict path resolution — so the blast radius of a misbehaving client is zero.
SQLite as the single store. FTS5 gives production-grade BM25 keyword search in the standard library, and sqlite-vec puts vectors in the same file. One database file, no services to run, trivial to back up or delete.
Hybrid search by default. BM25 and cosine-KNN rankings are fused with reciprocal-rank fusion (k=60). Exact identifiers and rare terms win on the keyword side; paraphrased questions win on the semantic side; RRF needs no score calibration between them.
modelets the caller force either side.Local embeddings. BAAI/bge-small-en-v1.5 (384-dim) — same size class as the classic all-MiniLM-L6-v2 but stronger on retrieval benchmarks. Downloads on first index, runs on CPU, lazy-loaded so server startup stays instant. If the model can't load, everything degrades gracefully to keyword search and tool responses say so.
A tool surface built for an LLM caller.
searchreturns enough per hit (path, location, score, snippet) to decide what to read next without another round trip; results carry stablechunk_ids; every degradation is reported in-band vianote/embedding_notefields instead of failing. There's no "answer the question" tool on purpose — the calling model does the reasoning; docsonar does retrieval.Incremental by content, not just mtime. Reindexing checks mtime+size first, then falls back to a SHA-256 content hash — touched-but-identical files are skipped, and deleted files are purged from both the FTS and vector indexes.
Scanned PDFs fail loudly. A PDF with no extractable text is reported as failed with a clear reason rather than silently indexed as empty. OCR is out of scope.
Benchmarks
Synthetic corpus of 200 markdown files (600 chunks); Intel Core Ultra 5 125U (laptop, CPU-only), Windows 11, Python 3.12. Reproduce with uv run python scripts/benchmark.py.
Operation | Result |
Index, keyword-only | 0.7 s (≈280 files/s) |
Index, with embeddings | 59 s (≈3.4 files/s — embedding-bound) |
Incremental reindex, nothing changed | 0.03 s |
Search, keyword | 8.9 ms median |
Search, semantic | 35 ms median |
Search, hybrid | 54 ms median |
Embedding model load (once per process) | ~21 s |
Database size | 2.6 MB (1.1 MB keyword-only) |
Configuration
Zero config needed. To customize, create config.toml in the platform config directory (Windows: %LOCALAPPDATA%\docsonar\, macOS: ~/Library/Application Support/docsonar/, Linux: ~/.config/docsonar/):
embedding_model = "BAAI/bge-small-en-v1.5" # any sentence-transformers model
chunk_target_tokens = 400
chunk_max_tokens = 512
chunk_min_tokens = 100
chunk_overlap_tokens = 60
max_file_size_mb = 50
extra_ignore_dirs = ["Archive"]CLI flags: --transport stdio|http, --host, --port, --db-path, --config.
The index database lives in the platform data directory (Windows: %LOCALAPPDATA%\docsonar\, macOS: ~/Library/Application Support/docsonar/, Linux: ~/.local/share/docsonar/).
Running from source
Requires uv (it installs the right Python automatically):
# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
git clone https://github.com/ribhav-jain/docsonar.git
cd docsonar
uv sync --dev # creates .venv and installs everything, incl. dev toolsRun the tests
uv run pytest # full suite (~2 s, no model download needed)
uv run pytest -v # verbose, one line per test
uv run pytest tests/test_search.py # one file
uv run pytest -k incremental # tests matching a keyword
uv run ruff check . # lint
uv run mypy src tests # strict typecheck
uv run python scripts/benchmark.py # perf numbers (downloads the real model)Run the server
uv run docsonar # stdio — for MCP clients (Claude Desktop/Code)
uv run docsonar --transport http --port 8365 # HTTP — for manual testing (Postman, curl)VS Code: press F5 — launch configs for the HTTP server and the test suite are in .vscode/launch.json.
Try the tools without an MCP client
With the HTTP server running, the endpoint is http://127.0.0.1:8365/mcp. Recent Postman versions can connect directly (New → MCP Request, transport HTTP) and show all 8 tools as forms. For raw HTTP, MCP is JSON-RPC over POST with two setup calls, then tool calls. Send every request with headers Content-Type: application/json and Accept: application/json, text/event-stream:
// 1. initialize — copy the `mcp-session-id` RESPONSE header and send it
// back as a request header on every call below
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"postman","version":"1.0"}}}
// 2. initialized notification (expect 202, empty body)
{"jsonrpc":"2.0","method":"notifications/initialized"}
// 3. list the tools
{"jsonrpc":"2.0","id":2,"method":"tools/list"}Then call tools — the repo ships a sample corpus in examples/sample-docs to play with (use forward slashes in JSON to avoid escaping; they work on Windows too):
// Register the sample folder (first ever call downloads the embedding model, ~30 s)
{"jsonrpc":"2.0","id":3,"method":"tools/call","params":{"name":"add_folder",
"arguments":{"path":"C:/path/to/docsonar/examples/sample-docs"}}}
// Watch indexing progress until indexing.active is false
{"jsonrpc":"2.0","id":4,"method":"tools/call","params":{"name":"index_status","arguments":{}}}
// Hybrid search — finds the expense-policy PDF, cites its page
{"jsonrpc":"2.0","id":5,"method":"tools/call","params":{"name":"search",
"arguments":{"query":"meal reimbursement limit","top_k":3,"mode":"hybrid"}}}
// Semantic search — no keyword overlap needed
{"jsonrpc":"2.0","id":6,"method":"tools/call","params":{"name":"search",
"arguments":{"query":"how hot should water be for green tea","mode":"semantic"}}}
// Read a hit (works on PDFs too — returns extracted text)
{"jsonrpc":"2.0","id":7,"method":"tools/call","params":{"name":"read_file",
"arguments":{"path":"C:/path/to/docsonar/examples/sample-docs/expense-policy.pdf"}}}
// "More like this"
{"jsonrpc":"2.0","id":8,"method":"tools/call","params":{"name":"find_similar",
"arguments":{"path":"C:/path/to/docsonar/examples/sample-docs/espresso-guide.md","top_k":3}}}
// Refresh after files change on disk (force:true rebuilds everything)
{"jsonrpc":"2.0","id":9,"method":"tools/call","params":{"name":"reindex","arguments":{}}}
// Clean up — unregisters the folder and purges its index data
{"jsonrpc":"2.0","id":10,"method":"tools/call","params":{"name":"remove_folder",
"arguments":{"path":"C:/path/to/docsonar/examples/sample-docs"}}}Security check worth trying: read_file with any path outside a registered folder (e.g. C:/Windows/System32/drivers/etc/hosts) returns a refusal, not file content.
CI runs lint, typecheck, and the test suite on Linux, macOS, and Windows.
License
MIT
Available Tools
8 toolsadd_folderA
Register a local folder so its documents become searchable.
Use this once per folder before searching it. Indexing runs in the
background — this returns immediately with the file count found; call
index_status to track progress (the first ever index also downloads
the embedding model, ~130 MB). path must be an absolute path to an
existing directory. Optional globs match paths relative to the folder
using forward slashes (e.g. include_globs=["docs/**/.md"],
exclude_globs=["drafts/"]); omit both to index every supported file.
Supported types: txt, md, pdf, docx, html.
Returns {ok, folder, files_found, status: "indexing"}. files_found counts supported files matching the globs; unsupported files are silently ignored. Searches issued while indexing runs work on the portion indexed so far.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| exclude_globs | No | ||
| include_globs | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full behavioral burden. It discloses background indexing, immediate return with file count, model download, absolute path requirement, glob matching semantics, supported file types, silent ignoring of unsupported types, and partial-search behavior during indexing. This is exceptional coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is about 120 words yet packed with essential details: purpose, usage timing, background behavior, glob semantics, supported types, return shape, and concurrency. It is front-loaded with purpose and avoids redundancy, earning every sentence.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (background indexing, globs, model download), the description covers prerequisites, return shape, edge cases (unsupported files silently ignored, partial search results), and the follow-up tool (index_status). No critical gap remains.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, but the description explains each parameter: path must be absolute and existing; include_globs/exclude_globs are illustrated with examples and matching rules (relative to folder, forward slashes). This fully compensates for the schema's lack of descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource: 'Register a local folder so its documents become searchable.' This clearly distinguishes it from siblings like remove_folder and reindex, and conveys the intended outcome immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says 'Use this once per folder before searching it,' and directs the user to 'call index_status to track progress.' It also notes the first index downloads a ~130 MB model, providing valuable context for when this tool is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
find_similarA
Find indexed documents most similar in meaning to a given file.
Use for "more like this" — e.g. finding related notes, duplicate
content, or other documents on the same topic. path must be a file
inside a registered folder that has already been indexed. Similarity
uses stored embeddings (whole-file centroid vs. best-matching chunks),
so it works even if the embedding model is not currently loaded.
Returns {ok, source, similar: [{path, file_type, score, preview},
...]}. score is cosine similarity (0-1, higher is more similar);
preview is the best-matching section's heading or opening text.
Returns an error if the file has no stored embeddings.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| top_k | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description fully bears the burden of behavioral disclosure. It explains that similarity uses stored embeddings (whole-file centroid vs. best-matching chunks), works even if the model is not loaded, returns cosine similarity scores and previews, and errors if the file has no stored embeddings. This is rich, honest transparency about inner workings and edge cases.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-organized into a brief overview, usage hint, technical mechanism, and return format, all within a few sentences. No fluff—each sentence adds value, from the purpose to the error condition. It is front-loaded with the most important information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the moderate complexity and presence of an output schema, the description does a strong job: it explains the return format, score meaning, preview semantics, and error conditions. It only misses the 'top_k' parameter explanation and could optionally mention that the result list is ordered by score. Overall, it is nearly complete but missing one key param detail.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 2 parameters with 0% description coverage, so the description must compensate. It adequately explains the required 'path' parameter ('must be a file inside a registered folder that has already been indexed'). However, the optional 'top_k' parameter is not mentioned at all, leaving the agent to guess its meaning. The description covers only half the parameters, earning a 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Find indexed documents most similar in meaning to a given file.' It further clarifies the use case with examples like 'related notes, duplicate content' and explicitly distinguishes from sibling tools such as search by framing it as 'more like this.' This is a clear, purpose-focused definition.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage context: 'Use for "more like this"' and lists concrete examples. It also states a prerequisite ('path must be a file inside a registered folder that has already been indexed'). However, it does not explicitly state when not to use it or mention alternatives like search for keyword queries, so it falls just short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
index_statusA
Report index health and background indexing progress.
Use after add_folder or reindex to check whether indexing has finished, or to diagnose why search results look incomplete (failed files, embeddings unavailable). Cheap to call.
Returns {ok, db_path, db_size_bytes, embedding: {model, status}, totals: {folders, files_indexed, files_failed, chunks, chunks_embedded}, indexing: {active, current: {folder, files_done, files_total} | null, queued_folders, recent_jobs}, failed_files: [{path, error}, ...] (up to 10)}. embedding.status is "ready", "not loaded yet ...", or "error: ..." — errors mean keyword-only search.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full disclosure burden. It details the entire return object structure, explains the embedding.status field and its error/not-loaded meanings, and mentions the limit of 10 failed files. This provides substantial behavioral context beyond a minimal 'get status' description.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured: a one-line summary, then usage guidance, then return format. It is a bit long due to detailed return spec, but every sentence adds value, though slightly redundant given an output schema exists. Still, it remains concise and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only status tool with no parameters, the description covers purpose, usage timing, return structure, and error interpretation. It even addresses diagnostic use cases and performance cost. This is fully sufficient for an agent to correctly select and invoke the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the baseline is 4. The description doesn't need to explain parameters, and the input schema is empty. No gaps to compensate for, so the score matches the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reports index health and background indexing progress. It also provides specific usage scenarios (after add_folder/reindex and for diagnosing incomplete search results), which distinguishes it from sibling tools like search or reindex that have different purposes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs when to use the tool: 'Use after add_folder or reindex to check whether indexing has finished, or to diagnose why search results look incomplete'. Also notes it's 'Cheap to call', setting expectations for frequent use. This is direct guidance on appropriate contexts.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_foldersA
List registered folders with file/chunk counts and last index time.
Use this to check what is searchable before calling search, or to find the exact registered path for remove_folder. Returns {ok, folders: [{path, files, failed_files, chunks, added_at, last_indexed_at}, ...]}.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full responsibility. It goes beyond a simple verb phrase by disclosing the exact return structure: 'Returns {ok, folders: [{path, files, failed_files, chunks, added_at, last_indexed_at}, ...]}.' This gives the agent a precise expectation of what the tool outputs, which is especially valuable since the input schema is empty and there is no other source of behavioral information.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: two sentences, with the core action first and the return format following. Every sentence adds value, including the usage guidance, and there is no filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having no parameters and a trivial input schema, the description covers purpose, use cases, and return format. It gives sufficient context for an agent to decide when to invoke it and what to expect, without requiring additional details like permissions or side effects since it is a read-only list operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so there is nothing to explain. Per the rubric, 0 parameters gets a baseline score of 4, and the description adds no parameter-specific semantics because none are needed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool lists registered folders with file/chunk counts and last index time. This specifically distinguishes it from sibling tools like search, add_folder, and remove_folder, making the purpose immediately obvious.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit usage guidance is provided: 'Use this to check what is searchable before calling search, or to find the exact registered path for remove_folder.' This directly tells the agent when to use this tool and ties it to related actions, covering both use cases and implicitly ruling out use for search or removal itself.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_fileA
Read the text of one indexed document, optionally a line range.
Use after search to pull full context around a hit. path must lie
inside a registered folder — anything else is refused (this server
never reads outside registered folders). Plain-text formats (txt, md)
return the raw file; binary formats (pdf, docx, html) return the
extracted text, paragraphs separated by blank lines.
start_line/end_line are 1-based and inclusive; omit both for the
whole file. Output is capped at ~100k characters; truncated is true
if the cap hit, in which case request a narrower line range.
Returns {ok, path, start_line, end_line, total_lines, truncated, text}.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| end_line | No | ||
| start_line | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully carries the safety and behavior disclosure. It reveals that paths outside registered folders are refused, distinguishes plain-text vs binary extraction, explains 1-based inclusive line ranges, caps output at ~100k characters with a 'truncated' flag, and lists the return structure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, well-organized paragraph with front-loaded purpose. Every sentence adds distinct value (usage, safety, format handling, parameters, output limits, return fields) with no filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read_file tool with an output schema, the description covers the full workflow (after search), all parameter behaviors, format differences, output cap, and return shape. It is complete enough for an agent to invoke correctly without external documentation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% and the description compensates richly. It defines path constraints (must be in a registered folder), explains start_line/end_line as 1-based and inclusive, says to omit both for the whole file, and clarifies the truncation behavior for the line range.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Read the text of one indexed document, optionally a line range,' a specific verb plus object. It distinguishes from siblings by positioning the tool as the follow-up to search, pulling full context around a hit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states 'Use after search to pull full context around a hit,' giving a clear when-to-use. It does not explicitly enumerate when-not-to-use or name alternatives, but the positioning relative to search and the registered-folder constraint provide sufficient context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reindexA
Refresh the index: pick up new, changed, and deleted files.
Use when documents changed on disk since they were indexed. Runs in
the background; track with index_status. Incremental by default —
unchanged files (by mtime, then content hash) are skipped, files
deleted from disk are purged from the index. folder limits the
refresh to one registered folder (path as shown by list_folders);
omit it to refresh all. force=true rebuilds every file from
scratch regardless of change detection (use after changing chunking
or embedding settings).
Returns {ok, queued: [folder paths], force}.
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | ||
| folder | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses key behaviors: background execution, incremental default with mtime/content hash skipping, purging of deleted files, folder limiting, force rebuild semantics, and the return value. This is comprehensive and exceeds the minimum.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured and appropriately sized. The opening sentence states the core purpose, followed by contextual usage, parameter explanations, and return value information. Every sentence earns its place with no fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers trigger conditions, change detection behavior, folder scoping, force usage, and return format. Even though an output schema exists, the added return value description is helpful. It is complete for a background maintenance tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It fully explains both parameters: 'folder' limits to a registered folder (path as shown by list_folders), and 'force=true' rebuilds every file from scratch. This adds meaning beyond the raw schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: 'Refresh the index: pick up new, changed, and deleted files.' It uses a specific verb and resource, and the scope is explicit, distinguishing it from sibling tools like index_status (status) and list_folders (listing).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use the tool: 'Use when documents changed on disk since they were indexed.' It also references index_status for tracking and explains the folder/force options. However, it does not explicitly state when not to use it or name alternative tools for the same action, so it falls just short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
remove_folderA
Unregister a folder and purge all its index data (files, chunks, search index).
The documents on disk are untouched — this only forgets them. Any in-progress background indexing of this folder is cancelled. Use list_folders to see what is registered. Returns {ok, folder, files_purged}.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description takes full responsibility for disclosing behavior. It states that all index data (files, chunks, search index) is purged, that on-disk documents are untouched, and that in-progress background indexing is cancelled. It also provides the return tuple. This is exemplary disclosure for a mutating tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, with the main action in the first sentence and essential clarifications in the second and third. Every sentence contributes useful information and there is no fluff. The structure loads the primary purpose first and then adds nuance, making it easy for an agent to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one parameter and an output schema (not shown in detail), the description covers the core behavior, side effects, and return value. It does not address error handling or idempotency, but given the tool's simplicity and the existence of an output schema, the description is reasonably complete. A small gap is the lack of any note about the folder needing to be registered, but that is implied by 'Unregister'.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The only parameter, 'path', has no schema description (0% coverage) and the tool description does not elaborate on the expected format, whether it must be absolute, or whether it needs to match the exact path used in add_folder. The description only uses the word 'folder', which is nearly synonymous with 'path'. Thus it provides no added semantic value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb phrase 'Unregister a folder and purge all its index data' and enumerates exactly what is purged (files, chunks, search index). It also clarifies the non-destructive effect on disk data, which distinguishes it from a delete operation. The tool name alone would be ambiguous, but the description eliminates that.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for removing a folder from the index, and explicitly points to list_folders for listing registered folders, giving context. It also warns that on-disk documents are untouched, which tells the agent not to use this tool if physical deletion is intended. However, it does not explicitly name alternatives like reindex or add_folder for comparison, so it stops short of full differentiation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchA
Search all indexed documents and return the most relevant passages.
Use this first whenever the user asks about the content of their local
documents. query is free text; full questions work well in hybrid/
semantic mode, plain keywords in keyword mode. top_k (1-50) caps
results. folder restricts to one registered folder (pass its path as
shown by list_folders); file_type restricts by extension (e.g. "md").
mode: "hybrid" (default — keyword + semantic fused with reciprocal-
rank fusion, best for most queries), "keyword" (exact-term BM25, best
for identifiers or rare exact words), or "semantic" (meaning-based,
best when wording differs from the documents).
Returns {ok, results: [{chunk_id, path, file_type, location, score,
snippet}, ...], mode_used, note}. location is a heading path like
"Setup > Windows" (or a page for PDFs), usable for citations. score
is normalized 0-1 within this result set. A non-null note means the
requested mode degraded (e.g. embeddings unavailable) and explains why.
Snippets highlight keyword matches with bold; read_file on a
result's path gets the full context.
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | hybrid | |
| query | Yes | ||
| top_k | No | ||
| folder | No | ||
| file_type | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully carries the transparency burden. It discloses the return format, score normalization (0-1), mode degradation via the `note` field, snippet highlighting with **bold**, and references `read_file` for full context. This gives the agent a clear model of what to expect and how to act.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then organized into logical sections: usage guidance, parameter explanations, and return value details. Every sentence carries meaningful information, with no redundancy or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a complex tool with 5 parameters, no annotations, and no schema descriptions. The description covers all parameters, explains return structure and edge cases (degradation note), and provides a next-step pointer (read_file). It is fully self-contained for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description compensates completely. It explains `query` behavior in each mode, `top_k` range (1-50), `folder` source (path from list_folders), `file_type` extension, and `mode` with three values and defaults. No parameter is left unclear.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource phrase: 'Search all indexed documents and return the most relevant passages.' It also includes scope ('all indexed documents') and a usage cue ('Use this first whenever the user asks about the content of their local documents') that distinguishes it from sibling tools like find_similar.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool ('Use this first whenever the user asks about the content of their local documents') and provides detailed mode selection guidance: 'best for most queries', 'best for identifiers or rare exact words', and 'best when wording differs'. This is clear and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
8 tool updates
v0.1.1- First observed
add_folder - First observed
find_similar - First observed
index_status - First observed
list_folders - First observed
read_file - First observed
reindex - First observed
remove_folder - First observed
search
TDQS
Scored across 8 tools
Each tool has a clearly distinct purpose: status reporting, folder listing, searching, similarity lookup, file reading, folder removal/addition, and reindexing. No two tools overlap in a way that would confuse an agent.
Most tools follow a snake_case verb_noun pattern (list_folders, add_folder, remove_folder, read_file), but a few deviate: 'search' and 'reindex' are single verbs, and 'find_similar' uses an adjective. The style is uniform and readable, but not perfectly consistent.
Eight tools is ideal for this document indexing/search server. The count is neither too thin nor bloated, and each tool addresses a necessary part of the workflow.
The tool surface covers the full lifecycle: folder registration (add_folder, remove_folder), inventory (list_folders), index health (index_status, reindex), and content access (search, find_similar, read_file). No significant gaps exist for the stated purpose.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Serve a folder of Markdown notes as an MCP server: hybrid search, reading, and sourced answers.
Personal knowledge base MCP server with semantic search, auto-categorization, metadata extraction
DocBase MCP server for AI agents
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceLocal MCP server that indexes folders of documents into a hybrid vector + keyword search index for Claude Desktop, with support for PDFs, Office files, and images via OCR.MIT
- FlicenseNot gradedqualityCmaintenanceMCP server enabling Claude Desktop to answer questions from local Word and PDF documents by searching a vector index built from their contents.-
- AlicenseNot gradedqualityBmaintenanceA local document search MCP server that indexes personal files and enables hybrid search (BM25 + semantic) for Claude to find and cite internal materials.MIT
- AlicenseAqualityBmaintenanceMCP server that indexes Claude.ai chats and local Claude Code sessions, enabling semantic and keyword search across all your conversations with Claude.66MIT
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/ribhav-jain/docsonar'
If you have feedback or need assistance with the MCP directory API, please join our Discord server