Skip to main content
Glama

ringkit_get_onboarding

Read-onlyIdempotent

Setup progress: the next step (number | done), whether the business has a number, whether the knowledge profile has the basics, and the latest website import.

Input Schema

NameRequiredDescriptionDefault
businessIdNoDefaults to the business of the API key in the Authorization header.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the safety profile is covered. The description's contribution is the returned state itself, which is useful, but it says nothing about defaulting behavior when the business has no number, how 'next step' is computed, or what happens with an unauthorized or malformed businessId.

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?

A single front-loaded sentence that leads with the resource and then the payload, with no filler. It is slightly telegraphic — the '(number | done)' notation is not self-explanatory and costs a moment of parsing.

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 burden of describing return values, and it does enumerate the four fields an agent gets back. It would be stronger if it clarified the shape of nested pieces such as the 'latest website import' or what 'has the basics' means in practice.

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 100% and the single businessId parameter is documented in the schema, including the fallback to the API key's business. The description adds nothing about the parameter, so the baseline of 3 applies.

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 identifies the resource (setup/onboarding progress) and enumerates the four pieces of state returned: next step, number presence, knowledge-profile basics, latest website import. The verb is implicit rather than stated, and nothing distinguishes it from near neighbors like ringkit_get_knowledge or ringkit_get_latest_knowledge_import, which it partially overlaps.

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?

There is no statement of when an agent should call this rather than ringkit_get_business, ringkit_get_knowledge, or ringkit_get_setup_chat, and no mention of prerequisites or typical sequencing (e.g. before ringkit_complete_onboarding). Usage must be inferred from the field list.

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