Skip to main content
Glama

search_document

Destructive

Search documents by query to find specific content. Returns matching lines with context and page numbers.

Instructions

Search for text within a document and return matching lines with context and approximate page numbers. Use this when you need to find specific content without reading the entire document. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filenameYesThe document filename to search
queryYesThe search query (case-insensitive)
Behavior1/5

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

Description claims 'Read-only,' which contradicts annotations (destructiveHint: true). This is a critical inconsistency. No mention of potential side effects or required permissions beyond the contradiction.

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?

Three sentences: one for purpose, one for usage guidance, one for behavior. Efficient and front-loaded with no redundant information.

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

Completeness2/5

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

Despite having only 2 parameters, the tool is a search operation with clear output description in text. However, the annotation contradiction undermines completeness; missing behavioral truth and no output schema information.

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?

Both parameters are fully described in the input schema (100% coverage), so the description adds no additional meaning beyond the schema. Baseline score of 3 appropriate.

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 clearly states the verb 'Search', the resource 'document', and specifics about output ('matching lines with context and approximate page numbers'). It effectively distinguishes from siblings like read_document and get_document_summary.

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?

Description explicitly says 'Use this when you need to find specific content without reading the entire document,' providing clear when-to-use guidance. However, it lacks explicit alternatives or when-not-to-use indications, but context from sibling tools suffices.

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/drolosoft/go-docs-mcp'

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