Skip to main content
Glama

Read usage guides

help
Read-only

Returns usage guides and command references for agent-device tools and topics. Call it to find flags, workflows, and platform-specific instructions before running a command.

Instructions

Return usage guides and command references. With no topic, returns the root decision card. The topic can be commands, manual-qa, maestro, workflow, scripting, gestures, tv, debugging, react-devtools, cdp, react-native, physical-device, ios-system-ui, foldable, remote, macos, web, dogfood, validate, or a tool name for its complete flag reference.

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
topicNoGuide topic or tool name; omit for the card.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.20.9

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds genuine behavioral detail beyond that: the no-topic default (root decision card) and the dual addressing mode (topic keyword vs. tool name yielding complete flag reference). It stops short of describing output shape, but no output schema exists and the content type is stated.

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 sentences, front-loaded with the core purpose, then the default behavior, then the value list. The long topic enumeration is dense but functional since it substitutes for a missing enum. Slightly list-heavy, but every item earns its place.

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 single-optional-parameter documentation tool with no output schema, the definition covers purpose, default behavior, and the full valid input space. The only omission is a hint about response size or format, which is minor given the tool returns static reference text.

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 the baseline would be 3, but the description goes further by enumerating all twenty-plus accepted topic values and explaining that a tool name returns that tool's flag reference. Since the schema declares no enum, this enumeration is real meaning the agent could not obtain elsewhere.

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 ("Return usage guides and command references") and explicitly frames the tool as a documentation lookup, which is clearly distinct from the action-oriented sibling tools like click, find, or gesture. An agent can tell immediately that this is the help/documentation surface rather than a device control.

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 a clear entry-point rule: "With no topic, returns the root decision card," which tells the agent to call it bare first when unsure. It also explains the tool-name fallback for flag references. It does not state explicit when-not-to-use conditions, but no sibling appears to overlap with documentation lookup, so the practical gap is small.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.