Skip to main content
Glama

search_project_docs

Search project documentation files for keywords or phrases using BM25 ranked search, with fallback to substring matching. Supports search within current project or globally across all projects.

Instructions

Search documentation files for a keyword or phrase. Automatically uses BM25 ranked search when index is available, falls back to grep (substring match) otherwise.

scope="project" (default): current project only, based on CWD. scope="global": search across ALL projects in the doc repository.

Use global scope when the user:

  • does not specify a project, or says 'all projects', 'everywhere', 'across projects'

  • references previously saved notes, knowledge, or past decisions

  • wants to compare how different projects handle the same topic

  • uses words like 'find everywhere', 'search everything', 'all docs'

  • asks in Korean: '전체', '모든 프로젝트', '다른 프로젝트에서는'

Use project scope (default) when the user asks about the current project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax results (default: 20)
modeNoOverride search mode. Options: "grep" (regex-only search, skips BM25 index). Omit for default hybrid search.
queryYesSearch query
scopeNoSearch scope: 'project' (default, current project only) or 'global' (all projects). Omit or set to 'project' for current project.
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses automatic BM25 fallback to grep and scope behavior. However, it doesn't describe what the output looks like (e.g., file names, snippets) or mention any rate limits or auth requirements, which would enhance transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with bullet points for scope guidance, and the main purpose is front-loaded. While every sentence adds value, it could be slightly more streamlined. Overall, it's appropriately sized and clear.

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 and 4 parameters, the description thoroughly explains search behavior and scope usage. It does not describe the return format or what happens with no results, but for a search tool, it covers the essential aspects for correct invocation.

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 100%, and the description adds significant value beyond the schema: it explains the default scope derived from CWD, provides concrete examples of when to use each scope (including Korean), and clarifies the mode parameter's effect (skipping BM25 index).

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 documentation files for a keyword/phrase, specifying two search mechanisms (BM25 ranked and grep) and two scopes (project and global). It distinguishes itself from sibling tools like 'search_vault' by targeting project docs specifically.

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?

Provides explicit and actionable guidance on when to use global vs project scope, including specific user language examples (e.g., 'all projects', 'everywhere', Korean phrases). It also implies default behavior for project scope. Though it doesn't mention alternatives like 'search_vault', the sibling list makes the differentiation clear.

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/epicsagas/alcove'

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