Skip to main content
Glama

add_client_onboarding_step

Add an optional step (by key from list_client_onboarding_optional_steps) to a client's onboarding checklist. (confirm-gated: previews until confirm: true)

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>"
    },
    "name": "add_client_onboarding_step"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.
stepKeyYes
clientIdYesClient's User _id (from list_clients)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false and destructiveHint=false; the description adds the materially important fact that the call is confirm-gated and returns a preview until confirm: true. That is real behavioral disclosure beyond the structured fields. It does not cover idempotency (what happens if the step already exists) or the success response, which keeps it at a 4.

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, front-loaded with the action and scope, followed immediately by the gating caveat. No filler or redundant restatement of the tool name.

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 three-parameter additive mutation with no output schema, the definition covers the key prerequisite, the confirm gate, and the preview behavior. Missing only edge-case behavior such as duplicate steps or error conditions, which is a minor gap rather than a blocker.

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?

Beyond the 67% schema coverage, the description supplies the origin of stepKey (a value from list_client_onboarding_optional_steps), which the schema does not state. The confirm semantics are already documented in the schema, so that part is repetition rather than added value.

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 and resource: 'Add an optional step ... to a client's onboarding checklist', and scopes it to keys sourced from list_client_onboarding_optional_steps. An agent can distinguish this from mark_client_onboarding_step / get_client_onboarding by the 'add an optional step' framing, though no sibling is named for direct contrast.

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?

Gives clear context for use: obtain the stepKey from list_client_onboarding_optional_steps, then add it. The confirm gate tells the agent the call is a two-phase operation. It stops short of stating when NOT to use it (e.g. versus marking an already-present step), so it falls just short of a 5.

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.