Skip to main content
Glama

get_onboarding

Read-only

Retrieve bounded onboarding discovery, exact source manifests, prior answers, and the customer-agent contract for a given onboarding ID.

Instructions

Read bounded discovery, exact source manifest, prior answers and the customer-agent contract.

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": {
      "arguments": "<arguments>"
    },
    "name": "get_onboarding"
  }
}

Input Schema

NameRequiredDescriptionDefault
argumentsYes
idempotency_keyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.4.0

TDQS

C2.5/5.0
Behavior3/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 that the read returns discovery bounds, an exact source manifest, prior answers, and the customer-agent contract, which is useful content context. It does not disclose auth, pagination, or error behavior, but with annotations a 3 is appropriate.

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 definition is a single sentence, front-loaded, with no filler. Its compactness contributes to ambiguity, but it is structurally efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with nested objects and zero schema descriptions, the definition is under-specified: it never explains parameters, output shape, or when to choose it over list_onboardings. The content list is helpful but insufficient for correct invocation.

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

Parameters1/5

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

Schema coverage is 0% and the description mentions none of the parameters. It does not explain onboarding_id, the nested basis/intent objects, or why a read operation takes an idempotency_key, leaving all parameter meaning to opaque names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a verb ('Read') and enumerates the kinds of onboarding data returned, but it never plainly says it retrieves a single onboarding record or distinguishes this tool from list_onboardings. The jargon ('bounded discovery', 'customer-agent contract') leaves the resource somewhat ambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use guidance, prerequisites, or alternative tools are mentioned. An agent must infer that this is for fetching one onboarding rather than listing them.

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