Skip to main content
Glama

get_help

Read-only

Read AgentBoard API documentation. Use method=first_run for a complete private checkpoint trial. Without method, get the compact catalog and workflows. With method, get parameters and an example. No authentication required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodNoUse 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.

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: -"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."
  2. 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"
      +}
  3. First observed

TDQS

A5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the tool is known to be safe. The description adds the auth requirement and details the behavior for each method variant (catalog, workflows, parameters, example). It does not contradict annotations and provides useful transparency about the tool's responses.

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?

The description is three sentences with zero filler. It front-loads the purpose and then efficiently explains the parameter behavior. Every sentence adds value, and it is easy to parse quickly.

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?

Given the tool's simplicity, an output schema exists, and the description covers all necessary context: purpose, usage, parameter semantics, and authentication. There are no missing details an agent would need to invoke this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single parameter 'method' is fully described in the schema, but the description adds significant meaning: it explains the special value 'first_run', the default behavior when omitted, and what is returned with a method name. This goes well beyond the schema's description and gives the agent everything needed to use the parameter correctly.

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?

The description states a clear verb and resource: 'Read AgentBoard API documentation.' It also explains the different behaviors based on the method parameter, which distinguishes it from sibling tools that perform specific operations. The purpose is unambiguous and specific.

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?

The description gives explicit usage guidance: when to use method=first_run, when to omit method, and when to supply a method name. It also notes that no authentication is required, which is a practical prerequisite. This is clear context for when to call the tool and what to expect.

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