Skip to main content
Glama

search_docs

Search a project's docs directory for reference documentation using semantic queries. Filter by category (product, architecture, etc.) and control result count. Finds relevant content with file paths and snippets.

Instructions

Search only the docs/ directory for reference documentation. Use this when the user specifically asks for "docs" or "documentation". Returns relevant documentation chunks with file paths and content snippets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch query. Can be a single word, multiple words, or a phrase. The search is semantic and will find relevant content even with partial matches.
categoryNoOptional: Filter by documentation category. Options: product, architecture, operations, api, guides, reference, or leave empty for all.
maxResultsNoMaximum number of results to return. Default is 10, maximum is 50.
Behavior3/5

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

No annotations are provided, so the description carries full burden. It describes semantic search and return format but does not explicitly state that the tool is read-only or non-destructive. The behavioral traits are adequately implied but not fully disclosed.

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 concise with two sentences, front-loaded with purpose and usage guidance. No unnecessary words or redundancy.

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

Completeness4/5

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

Given no output schema, the description mentions return format (chunks with paths and snippets) which is sufficient. It covers when to use and all parameters are detailed in schema. Slightly lacks details on output structure but adequate for agent decision.

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

Parameters4/5

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

Schema description coverage is 100%, so baseline is 3. The description adds value by clarifying the scope (docs/ directory) and the semantic nature of search with partial matches, which is not present in the schema parameter 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 clearly states the tool searches only the docs/ directory for reference documentation, returning relevant chunks with file paths and snippets. It distinguishes from sibling tools like search_project and get_doc by specifying scope and purpose.

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?

Explicitly advises using this tool when the user specifically asks for 'docs' or 'documentation', providing clear usage context. However, it does not explicitly mention when not to use it or compare directly with alternative tools like search_project.

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/pouyanafisi/project-mcp'

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