Skip to main content
Glama

Help docs

search-help
Read-only

Use this when the user asks how to do something in WebTwizz, how a WebTwizz feature works, or about plans and limits. Searches the WebTwizz docs and returns the best matching pages with the lines that match and links; call it again with a page title to read one in full.

Input Schema

NameRequiredDescriptionDefault
pageNoA page title from an earlier help result, to read that page in full
questionNoWhat the user wants to know, in their words

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly/openWorld=false safety, so the bar is lower; the description still adds value by disclosing the two-phase search-then-read flow and the shape of results (matching pages, matched lines, links). It stops short of describing ranking, result limits, or what an empty/no-match response looks like.

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, zero waste, and the use-case trigger is front-loaded ahead of the mechanics. Each clause earns its place.

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?

For a two-param read-only retrieval tool with no output schema, it supplies the trigger conditions, the return content, and the follow-up pattern. An agent has everything needed to decide when to call it and how to continue from the result.

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?

Schema coverage is 100%, so both parameters are already documented. The description adds the workflow relationship between them — `page` is used on a second call to read in full, `question` is for the initial search — which clarifies sequencing beyond the standalone field text.

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 ('Searches the WebTwizz docs') plus the return content ('best matching pages with the lines that match and links'). This is clearly distinct from the site-management siblings, which cannot be confused with a docs lookup.

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?

Opens with an explicit trigger set: 'when the user asks how to do something in WebTwizz, how a feature works, or about plans and limits.' It also names the follow-up pattern ('call it again with a page title to read one in full'), so both invocation modes are routed.

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