Skip to main content
Glama
gitmem-dev

GitMem

Official
by gitmem-dev

index_docs

Scan markdown files, chunk and embed them into a searchable index for semantic retrieval. Only re-processes changed files to save time.

Instructions

Scan a directory of markdown files, chunk them, embed them, and store them in a local doc index for semantic search. Supports incremental indexing: only re-processes changed files. Use search_docs to query the indexed docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
clearNoClear the doc index for this project before indexing (default: false)
forceNoForce re-index all files even if unchanged (default: false)
excludeNoDirectory names to exclude (default: ['_archive', 'node_modules', '.git'])
projectNoProject namespace (e.g., 'my-project'). Scopes sessions and searches.
directoryYesAbsolute path to directory containing .md files to index
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden. It discloses incremental indexing behavior but lacks details on side effects (e.g., overwrite, resource usage, error states). The 'clear' and 'force' parameters are only in schema, not described here.

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?

Two sentences efficiently convey core function, incremental support, and cross-reference to sibling tool. No unnecessary words; front-loaded with key action.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Description explains the process and incremental indexing but omits return value, error handling, and whether execution is synchronous or asynchronous. While schema covers parameters, the overall context for an agent is adequate but not thorough.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description does not add extra meaning to parameters beyond what the schema provides, so it meets the baseline without exceeding.

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 clearly states the tool indexes markdown files for semantic search, specifying the verb 'scan, chunk, embed, store' and the resource 'directory of markdown files'. It distinguishes from sibling tool 'search_docs' by mentioning it as the query counterpart.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains incremental indexing and directs to 'search_docs' for queries, providing context on when to use the tool. However, it does not explicitly state when not to use it or list alternatives for other file types.

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/gitmem-dev/gitmem'

If you have feedback or need assistance with the MCP directory API, please join our Discord server