Skip to main content
Glama

search_documents

Search SSearch-owned stored full-text documents. Successful misses can be promoted into the live index.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
promoteNo
max_resultsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations, the description carries the burden. It discloses that successful misses can be promoted into the live index, which is a behavioral trait beyond the search itself. However, it does not detail side effects, permissions, or return behavior.

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?

Two sentences, minimal, front-loads the main action clearly, 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?

No output schema and no parameter descriptions; the description leaves the return format and the exact behavior of parameters unexplained. For a 3-param tool with no annotations, this is insufficient.

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

Parameters2/5

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

Schema coverage is 0%, so description must compensate. It only implies query via 'Search' and vaguely references promotion for the promote parameter, but does not explain max_results or clarify how promote works. Lacks meaningful parameter guidance.

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?

States a specific verb and resource: 'Search SSearch-owned stored full-text documents.' This clearly differentiates from siblings like search_web, search_sources, and get_document by scoping to SSearch-owned full-text. The additional note about promotion further distinguishes it.

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?

Provides clear context that the tool searches SSearch-owned stored documents, implying when to use it (internal full-text) versus siblings, but does not explicitly name alternatives or exclusion conditions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources