Skip to main content
Glama

agent_tool_help

Returns usage guide for agent-tool. Call this when you encounter encoding warnings, garbled text, or need to understand agent-tool features. Topics: overview, encoding, indentation, tools, debug, analyze, troubleshooting.

Instructions

Returns usage guide for agent-tool. Call this when you encounter encoding warnings, garbled text, or need to understand agent-tool features. Topics: overview, encoding, indentation, tools, debug, analyze, troubleshooting.

Input Schema

NameRequiredDescriptionDefault
topicNoHelp topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, wintool, codegraph, troubleshooting. Empty = overview

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.2
    • changedInput schema / properties / topic / description
      Previous value: -"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, wintool, codegraph, ipc, troubleshooting. Empty = overview"New value: +"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, wintool, codegraph, troubleshooting. Empty = overview"
  2. Addedv0.8.7
  3. Removed
  4. Changed1 schema field changedv0.7.12
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "content": {
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "content"
      -  ],
      -  "type": "object"
      -}New value: +null
  5. Changed1 schema field changedv0.7.2
    • changedInput schema / properties / topic / description
      Previous value: -"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, troubleshooting. Empty = overview"New value: +"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, wintool, troubleshooting. Empty = overview"
  6. Changed1 schema field changedv0.7.1
    • changedInput schema / properties / topic / description
      Previous value: -"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, troubleshooting. Empty = overview"New value: +"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, memtool, troubleshooting. Empty = overview"
  7. Changed1 schema field changedv0.7.0
    • changedInput schema / properties / topic / description
      Previous value: -"Help topic. Available: overview, encoding, indentation, tools, troubleshooting. Empty = overview"New value: +"Help topic. Available: overview, encoding, indentation, tools, debug, analyze, troubleshooting. Empty = overview"
  8. First observedv0.4.2

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses that it returns a usage guide and lists topics, but does not explicitly state that it is read-only or has no side effects. For a help tool this is low risk, but the description could be more transparent about the operation's safety.

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?

The description is three short, front-loaded lines: purpose, when to call, and topics. The topics list is somewhat redundant with the schema, but overall there is little waste and the structure is easy to scan.

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 simple help tool with one optional parameter and no output schema, the description covers purpose, triggers, and topics. It does not describe the return format, but since the output is free-form help text, that omission is minor. The definition is sufficient for correct invocation.

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 the schema already documents the single 'topic' parameter thoroughly. The description lists a subset of topics but adds no syntax, format, or default behavior beyond what the schema provides. Baseline 3 is appropriate.

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 states a specific verb and resource: 'Returns usage guide for agent-tool.' It clearly distinguishes from siblings (edit, write, read, etc.) since it is the only help-oriented tool. However, 'agent-tool' is slightly ambiguous as it could refer to the tool itself or the broader server.

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?

It explicitly states when to call: 'Call this when you encounter encoding warnings, garbled text, or need to understand agent-tool features.' No alternatives exist among siblings, so no exclusions are needed. The triggers are clear and actionable.

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