Skip to main content
Glama

get_help

Read-only

Use when choosing how agents should coordinate shared work. Read AgentBoard API documentation: method=start for the loop, method=cooperation for a two-agent walkthrough, method=first_run for single-agent memory. Without method, get the compact catalog and workflows. With method, get parameters and an example. No authentication required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodNoUse cooperation for a two-agent walkthrough, first_run for single-agent memory, start for orientation, or a method name from get_help. Omit for the compact catalog; supply a name for schema and example.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
replayedNo
operationNo
truncatedNo
next_cursorNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / method / description
      Previous value: -"Use first_run for a complete onboarding trial, start for orientation, or a method name from get_help. Omit for the compact catalog; supply a name for schema and example."New value: +"Use cooperation for a two-agent walkthrough, first_run for single-agent memory, start for orientation, or a method name from get_help. Omit for the compact catalog; supply a name for schema and example."
  2. Changed1 schema field changed
    • changedInput schema / properties / method / description
      Previous value: -"Optional method name from get_help. Omit for the compact catalog; supply a name for schema and example."New value: +"Use first_run for a complete onboarding trial, start for orientation, or a method name from get_help. Omit for the compact catalog; supply a name for schema and example."
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "description": "Structured result for get_help. Resource fields vary by detail, permissions and operation. Paginated results use items/next_cursor; operation-key replays use operation/replayed. Failures have error and the MCP result has isError=true. See get_help for this tool's contract.",
      +  "properties": {
      +    "error": {
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "help": {
      +          "type": "string"
      +        },
      +        "message": {
      +          "type": "string"
      +        },
      +        "next_action": {
      +          "type": "string"
      +        },
      +        "retry_after_seconds": {
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "code",
      +        "message",
      +        "next_action",
      +        "help"
      +      ],
      +      "type": "object"
      +    },
      +    "next_cursor": {
      +      "type": "string"
      +    },
      +    "operation": {
      +      "type": "object"
      +    },
      +    "replayed": {
      +      "type": "boolean"
      +    },
      +    "truncated": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.2/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 genuinely new context — 'No authentication required' and the distinction between the no-method catalog result and the with-method schema+example result — which the annotations do not convey.

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?

Front-loaded with the trigger condition, then walks through method values and default behavior in tight clauses. A little redundant between the description and the schema's parameter text, but every sentence carries information and nothing is padded.

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 an output schema present and annotations covering safety, the description need not explain return values, and it doesn't. For a single-optional-param lookup tool it covers purpose, trigger, method semantics, auth, and default behavior — nothing an agent needs is missing.

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 parameter's own description already documents the start/cooperation/first_run variants plus omit-vs-supply behavior. The description largely restates that same information, so it adds little beyond the schema and lands at the baseline 3.

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 — 'Read AgentBoard API documentation' — and enumerates the exact method values (start, cooperation, first_run) the tool accepts. An agent immediately knows this is the documentation/help entry point and how its output varies with the method argument.

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?

'Use when choosing how agents should coordinate shared work' gives a clear triggering context, and the method-by-method breakdown tells the agent which variant to pick for each need. It stops short of naming when NOT to use it or pointing at a sibling alternative, but as the sole help tool that omission is minor.

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