Skip to main content
Glama

Get Onboarding Status

get_onboarding_status
Read-onlyIdempotent

Check the user's onboarding progress. Returns which steps are completed, which are required, and whether onboarding is fully complete.

Input Schema

NameRequiredDescriptionDefault

No arguments

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/idempotentHint/non-destructive, so safety is covered. The description goes beyond that by disclosing the shape of the response (completed steps, required steps, overall completion flag), which is valuable because no output schema exists. It stops short of noting permission requirements or freshness/caching behavior.

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?

Two short sentences, purpose first, return detail second, zero filler or restatement of the title.

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 zero-parameter, read-only status tool with no output schema, the description covers purpose and return contents adequately. The remaining gap is entity disambiguation among the many onboarding-related siblings.

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 the baseline is 4; there is nothing for the description to document or clarify on the input side.

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 verb ('Check') and resource ('the user's onboarding progress') plus the returned content. However, the sibling list contains several near-identical onboarding tools (get_agent_onboarding, get_customer_onboarding, onboarding_v7, complete_onboarding), and the description does nothing to distinguish which onboarding entity this targets.

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?

It says what it does but never when to call it versus the many sibling onboarding tools, nor any prerequisite (e.g. after which step it becomes meaningful). Usage is only inferable from the tool name, which is exactly what the description should be adding value over.

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