Skip to main content
Glama

search_docs

Read-only

Search your documents by name. Returns matches with their URLs and latest versions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qYesSearch query matched against doc names.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
docsYes
queryNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so safety is covered. The description adds that matching is by name and that results include URLs and latest versions, but it does not disclose possible limitations such as pagination, result caps, or exact/partial matching behavior. This is acceptable but not rich.

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 a single sentence with no filler. The core action is front-loaded, and the return value summary is given in a compact clause.

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?

This is a simple read-only search tool with one well-documented parameter and an output schema present. The description covers the main behavior and return contents. It could be slightly more complete with explicit alternative guidance, but nothing essential is missing.

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?

The input schema already documents q as 'Search query matched against doc names' with 100% coverage. The description reinforces the name-matching semantics but adds no new details about query syntax, formatting, or edge cases beyond the schema.

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 states a specific action ('Search your documents by name') and the resource, and additionally specifies what is returned ('matches with their URLs and latest versions'). This clearly distinguishes it from the sibling tools create_doc and get_doc.

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?

The use case is clear: search documents by name. However, it does not explicitly explain when to prefer this over get_doc or create_doc, nor does it state exclusions such as 'this does not search document contents.' Still, the described behavior provides adequate context for selection.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool targets a distinct operation: create, retrieve, and search. There is no overlap between the actions, and the descriptions reinforce their differing purposes.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern: create_doc, get_doc, search_docs. The only slight variation is singular 'doc' versus plural 'docs', which does not harm predictability.

Tool Count5/5

Three tools is a reasonable, focused set for a document storage service. Each tool handles a distinct core need and none feel redundant or unnecessary.

Completeness4/5

The core document lifecycle of create, read, and search is covered, with versioning handled through create. A minor gap is the absence of a delete or full list-all operation, though agents can likely work around that for most workflows.

Resources