Skip to main content
Glama

docs.search

Read-onlyIdempotent

Search the published OpenAPI operation catalog for relevant help.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum matching operations, from 1 to 20; defaults to 10.
queryYesSearch terms for the public OpenAPI operation catalog (1–200 characters); all whitespace-separated terms must match.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYes
resultsYes
deepLinkYesEvalGate web path or absolute URL for inspecting these results.
explanationYesHuman-readable interpretation and evidence limitations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the safety profile is fully covered. The description adds the useful scope detail that only the *published* catalog is searched, but says nothing about result freshness, ranking behavior, or failure modes.

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?

A single short sentence with no filler, and the search target is front-loaded. It is efficient, though it is arguably terse enough that a little more substance would have helped without harming readability.

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?

An output schema exists, so return-value explanation is not required, and both parameters are well documented. For a simple closed-world read tool this is close to sufficient, but with zero usage guidance the definition is only minimally viable rather than complete.

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?

Schema description coverage is 100%, so both 'query' (term matching, all whitespace-separated terms must match) and 'limit' (1–20, default 10) are already fully documented. The description adds no additional parameter meaning, which is the expected baseline when the schema carries the burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource: 'Search the published OpenAPI operation catalog.' An agent knows exactly what corpus is queried and that the goal is finding relevant operations/help. It falls short of a 5 only because it does no sibling differentiation, though the listed siblings (connections.*, runs.*, project.*) are unrelated namespaces so the risk of confusion is low.

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

Usage Guidelines2/5

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

There is no when-to-use or when-not-to-use guidance and no named alternative. The agent must infer from the resource name alone that this tool is for documentation lookup rather than, say, connector health or run inspection. No prerequisites or context for invocation are stated.

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