Skip to main content
Glama

Help and full documentation

help
Read-onlyIdempotent

Full documentation of any tool: arguments, rules, examples. topic: overview (default), a tool name, or an old tool name (deprecated, still works). Same text as fordeal://docs/.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "help"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicNooverview, a tool name or an old tool name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world reads, so the safety profile is covered. The description adds useful behavioral facts: an unspecified topic defaults to overview, and deprecated tool names still resolve. It says nothing about output format or size, but for a documentation lookup that is minor.

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?

Two tight sentences with the resource and contents front-loaded ahead of parameter details, so nothing is buried. The telegraphic 'topic: ...' fragment is efficient but slightly clipped compared to full prose.

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?

For a zero-required-parameter, read-only lookup with no output schema, the description covers what the tool returns and how the topic resolves, which is enough to call it correctly. Only the shape and size of the returned documentation are left unspecified.

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 coverage is 100% and the single optional parameter is already documented there, so the schema does the heavy lifting. The description adds only marginal meaning beyond it, namely that old/deprecated names are accepted and still work and that overview is the default. That is a slight lift over baseline, not a substantial one.

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 (returns full documentation for any tool) plus what the docs contain: arguments, rules, examples. No sibling tool provides documentation, so the agent can distinguish it from the domain tools (deals, search, shops) without opening a schema.

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?

Gives clear context for the parameter: default is overview, and a tool name or an old tool name both resolve. It does not explicitly say when to prefer this over directly reading schemas or when not to call it, so it stops short of full when/when-not guidance.

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