Skip to main content
Glama

find_docs

Locates README files and documentation within a local directory's docs/ folders. Use optional glob patterns to include or exclude specific paths.

Instructions

Hunts for README files and documentation inside docs/ folders in a local directory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirPathYesThe absolute path to the local directory to explore.
includePathNoOptional. Glob patterns to include in scanning.
excludePathNoOptional. Glob patterns to exclude from scanning.
Behavior2/5

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

No annotations provided, so description must carry full burden. It lacks details on what happens if directory doesn't exist, recursion behavior, case sensitivity, or output format. Only states the search action without behavioral nuances.

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?

Single, direct sentence with no filler. Every word adds value, achieving maximum conciseness.

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?

For a simple tool with 3 parameters and no output schema, description covers the core action but omits return format, error handling, and edge cases. 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 schema already documents all parameters. Description adds no extra meaning beyond the schema, meeting baseline but not 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?

Description uses specific verb 'hunts' and clearly states resource 'README files and documentation' and location 'inside docs/ folders in a local directory'. It effectively distinguishes from sibling tools like search_docs or read_file.

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

Usage Guidelines2/5

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

No guidance on when to use or avoid this tool versus alternatives. Among 23 sibling tools (e.g., search_docs, verify_docs), there is no differentiation or context for selection.

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/reasvyn/docsgrep'

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