Skip to main content
Glama

mark_client_onboarding_step

Set one onboarding step's status (confirm-gated). Use get_client_onboarding for the step key. status: DONE to tick it off, SKIPPED to skip it, PENDING to reopen. The instance auto-completes when every step is DONE or SKIPPED.

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>",
      "stepKey": "<stepKey>",
      "status": "<status>"
    },
    "name": "mark_client_onboarding_step"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusYes
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.
stepKeyYes
clientIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=false), the description discloses the confirm gate and, importantly, a downstream side effect: the instance auto-completes once every step is DONE or SKIPPED. That side effect is real behavioral context the agent cannot get from the annotations. It does not say whether repeated calls are idempotent or what happens on an unknown stepKey.

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?

Three tight sentences: the action and its gating come first, then the prerequisite lookup, then enum semantics and the completion rule. No filler and every clause adds usable information.

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 4-parameter mutation tool with no output schema, the description covers the gating requirement, the state values, the source of the step key, and the aggregate completion behavior. What is missing is failure/edge behavior (invalid step key, idempotency, what a preview response contains), which is a modest gap rather than a blocking one.

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 description coverage is only 25%, so the description needs to carry more weight; it does explain the status enum's meaning and where stepKey comes from. However, clientId and confirm are not explained in the description (confirm is documented only in the schema), so the compensation for the low coverage is partial.

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 gives a specific verb and resource ('Set one onboarding step's status') plus a scope qualifier ('confirm-gated'), so the agent knows exactly what is mutated. It routes to get_client_onboarding for the step key, but does not explicitly distinguish this from add_client_onboarding_step or dismiss_client_onboarding, leaving some sibling separation to inference.

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

Usage Guidelines4/5

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

It names a concrete prerequisite flow (use get_client_onboarding to obtain the step `key`) and explains which status value fits which intent (DONE to tick off, SKIPPED to skip, PENDING to reopen). It stops short of stating when NOT to use this tool, e.g. when a step should be added or removed instead.

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.