Skip to main content
Glama

search

Search indexed PDF documents for relevant text chunks by query. Optionally specify result count or restrict search to a specific document.

Instructions

Search indexed PDF documents for relevant chunks.

Args: query: The search query text n_results: Maximum number of results to return (default: 5) document: Optional specific document filename to search within

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
documentNo
n_resultsNo
Behavior2/5

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

No annotations provided, so the description must fully disclose behavior. It states the tool searches for chunks but does not mention that it is read-only, any required authentication, rate limits, or how relevance is determined. Minimal transparency beyond functionality.

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 extremely concise: one sentence defining the purpose followed by a clear list of parameter explanations. Every part is earned, no redundancy.

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?

The description covers the core functionality and parameters but lacks explanation of return values (no output schema), error handling, or how to interpret results. Also missing context on when to use this tool relative to siblings. Adequate but with notable gaps.

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?

Despite 0% schema description coverage, the description explains all three parameters: query (search text), n_results (max count, default 5), and document (optional filter). This adds meaning beyond the bare schema, though the format or constraints could be more detailed.

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 indexed PDF documents for relevant chunks. It distinguishes from sibling tools 'list_documents' (listing all documents) and 'get_document_info' (getting info on a specific document) by focusing on content search.

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

Usage Guidelines3/5

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

No explicit guidance on when to use this tool versus alternatives. The description implies usage for searching within documents, but does not mention when not to use it or provide context for sibling tools.

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/johwiebe/docstore'

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