Skip to main content
Glama
BitFigther

local-docs-mcp

by BitFigther

search_documents

Search local documents by keyword to find relevant files with context snippets.

Instructions

DOCS_ROOT 配下のドキュメントを全文検索する。

Args:
    query: 検索キーワード。スペース区切りで複数指定するとAND検索(大文字小文字は区別しない)。
    max_results: 返す文書数の上限。

Returns:
    マッチした文書ごとに 相対パス・マッチ回数・前後の抜粋(snippets) を、マッチ回数の多い順で返す。
    本文全体が必要なら read_document を使うこと。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
max_resultsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

No annotations, so description carries burden. It discloses search semantics (AND, case-insensitive), return format (relative path, match count, snippets), and ordering. Lacks explicit statement of read-only nature, but search inherently non-destructive.

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?

Very concise: one sentence for purpose, bullet-like Args/Returns with no redundant text. Every sentence adds value.

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?

For a search tool with output schema, description covers search behavior, return ordering, and directs to read_document for full text. Fully sufficient.

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 has 0% description coverage, but description explains 'query' as space-separated AND search and case-insensitive, and 'max_results' as upper limit with default 10. Adds significant meaning beyond schema.

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 it performs full-text search on documents under DOCS_ROOT. It distinguishes from siblings: 'If need full text, use read_document' and implicitly lists vs search.

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?

Explicitly says to use read_document for full text, describes AND search with space-separated keywords, and gives return order. Provides clear context for when to use.

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/BitFigther/local-docs-mcp'

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