Skip to main content
Glama

Get Onboarding Status

get_onboarding_status
Read-only

Check the current onboarding status of the user's account.

WHEN TO CALL:

  • At the start of every conversation to determine if onboarding is needed

  • Immediately after receiving an onboarding-related error from any core tool

  • After calling submit_business_data to see updated missing fields and progress

RESPONSE INTERPRETATION:

  • status: 'NEW' → No data collected yet; call submit_business_data with any available fields

  • status: 'BUSINESS_DATA_PENDING' → Partial data saved; guidance.fieldsNeeded lists what's still missing

  • status: 'SUBMITTED' → All data submitted, awaiting carrier approval (~1 business day); do NOT re-submit

  • status: 'ACTIVE' or 'MANUAL_REVIEW' → Account is ready; all core tools are available

The 'guidance.fieldsNeeded' array is computed dynamically from the stored draft — it always reflects exactly what's still missing. The 'progress' object tracks overall completion percentage.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
statusYes
guidanceNo
progressNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true; the description goes well beyond that by disclosing the full status lifecycle (NEW, BUSINESS_DATA_PENDING, SUBMITTED, ACTIVE, MANUAL_REVIEW), the ~1 business day carrier approval delay, and the fact that guidance.fieldsNeeded is recomputed dynamically from the stored draft. It also warns against a costly misuse (re-submission), which is exactly the kind of behavioral context annotations cannot carry.

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?

Headers and front-loaded bullets make the call/interpret split scannable, and each status mapping is one line. It is on the long side for a zero-param read, and the RESPONSE INTERPRETATION section necessarily restates some of what the output schema already exposes, but the enum meanings earn most of the space.

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?

For a no-parameter read with an output schema and only readOnlyHint for annotations, this covers everything an agent needs: when to call, how to read each status, what to do next, and what to avoid. No meaningful gap remains.

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

Parameters4/5

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

The tool takes zero parameters, so there is nothing to document and the baseline of 4 applies. The description instead spends its space on response semantics, which is the right trade-off for a no-arg call.

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 ('Check the current onboarding status of the user's account') and frames it as a read/state-inspection tool, which separates it cleanly from the mutating siblings like submit_business_data, add_subscribers, and send_message. An agent knows exactly what this returns without opening the schema.

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 'WHEN TO CALL' block gives three concrete triggers (conversation start, after an onboarding-related error, after submit_business_data) and the RESPONSE INTERPRETATION block adds an explicit exclusion: on 'SUBMITTED', do NOT re-submit. Alternatives are named where they matter (call submit_business_data when status is NEW).

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