Skip to main content
Glama

onboard

Get a personalized setup checklist for an agent with registration status, required next steps, and initial actions.

Instructions

Get personalized onboarding checklist for an agent. Shows registration status, next steps, and what to do. Start here if you are new.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
nameYesAgent name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A3.8/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 behavioral burden. "Get" and "Shows" imply a read-only operation, and the description discloses the returned information, but it does not explicitly state side effects, permissions, or whether any state is changed.

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 short sentences with no wasted wording. The purpose is front-loaded, followed by return contents and usage guidance.

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 one-parameter onboarding tool with no output schema, the description covers purpose, returned information, and when to start. It is nearly complete, though it could say more about what the checklist contains or whether the call is purely informational.

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%, and the single parameter is already documented as "Agent name." The description adds only that the checklist is "for an agent," which does not add meaningful semantics beyond the schema.

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: get a personalized onboarding checklist for an agent. It also lists the checklist contents, making the tool's purpose clear, though it does not explicitly differentiate itself from siblings like register_agent or check_agent.

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?

It gives clear usage context with "Start here if you are new," which tells a new agent when to use this tool. It does not name alternatives or when-not-to-use conditions, so it falls short of full routing guidance.

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