Skip to main content
Glama

Search help articles

search_help_articles
Read-only

Search stub's published help articles (the product docs) for a how-to. Use it when no guide from list_guides covers the question. Read-only; returns up to five matches, best first, each with a slug for get_help_article. pro: true marks a paid-plan feature.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesWhat the user wants to do, in their words, e.g. "invite my accountant".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only declare readOnlyHint, so the description adds meaningful context: it discloses the result cap (up to five), ordering (best first), the presence of a slug for follow-up via get_help_article, and the meaning of the `pro` flag. It does not cover pagination or what happens on zero matches, keeping it out of the top band.

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?

Three dense sentences, front-loaded with the resource and the routing condition, then the return-shape facts. Every clause earns its place with no redundancy.

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

Completeness5/5

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

With no output schema available, the description fills the gap by describing the return shape (count, ordering, slug, pro flag), and the usage condition plus read-only note round out everything needed to invoke it correctly.

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% and the single query parameter already has an example, so the description adds no syntax or format detail beyond the schema. Baseline 3 is appropriate when the schema does the heavy lifting.

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 (search) and resource (published help articles/product docs) with the scope of results. It is clearly distinguishable from siblings list_guides and get_help_article, which the description references by name.

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

Usage Guidelines5/5

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

Gives an explicit triggering condition ('when no guide from list_guides covers the question'), naming the alternative tool that should be tried first. An agent knows exactly when to route here versus elsewhere.

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