Skip to main content
Glama
ribhav-jain

docsonar

by ribhav-jain

add_folder

Register a local folder to make its documents searchable. Indexes supported files in the background, with optional include/exclude globs.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
exclude_globsNo
include_globsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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.

Conciseness5/5

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.

Completeness5/5

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.

Parameters5/5

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.

Purpose5/5

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.

Usage Guidelines5/5

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.

Install Server

Other Tools

Latest Blog Posts

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