Skip to main content
Glama

get_client_onboarding

Read-only

The onboarding checklist for one client (by User _id), or null if there is none / it was dismissed. Returns each step's key, type, title, status (PENDING|DONE|SKIPPED) and any auto-setup error, plus completed/total counts.

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": {
      "clientId": "<clientId>"
    },
    "name": "get_client_onboarding"
  }
}

Input Schema

NameRequiredDescriptionDefault
clientIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description goes further by disclosing the null return contract (no checklist or dismissed) and the per-step fields plus error and count aggregates. That null-case disclosure is the kind of context an agent actually needs to avoid misreading an empty result.

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?

Two dense sentences, front-loaded with the resource and scope, then the return shape. No wasted clauses, though the parenthetical '(by User _id)' slightly disrupts flow.

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?

With no output schema, the description carries the return-value burden and does so adequately: step fields, status enum, error field, and completed/total counts are all named. It is thin only on parameter provenance and on how this differs from the optional-steps sibling.

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 0%, so the schema documents nothing about clientId. The description partially compensates by clarifying it is a User _id, but gives no format example, no indication of where such an id comes from, and no error behavior for an invalid id.

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?

States a specific resource and scope: the onboarding checklist for exactly one client, keyed by User _id, with a precise definition of the null case. It is clearly distinguishable from mutation siblings like mark_client_onboarding_step or dismiss_client_onboarding, though it never explicitly contrasts itself with list_client_onboarding_optional_steps.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: an agent can infer this is the tool for reading a single client's checklist, and the null-if-dismissed note hints at when it returns nothing. There is no explicit when-to-use / when-not-to-use guidance nor a pointer to the optional-steps or dismiss tools.

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.