Skip to main content
Glama

list_client_onboarding_optional_steps

Read-only

Onboarding steps not yet on a client's checklist that can be added (their keys feed add_client_onboarding_step).

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

Input Schema

NameRequiredDescriptionDefault
clientIdYesClient's User _id (from list_clients)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety and locality are covered. The description adds the useful filtering semantics (only steps not already on the checklist) and the shape of the returned keys, but says nothing about ordering, size of the result set, or whether it is per-client scoped beyond the single clientId.

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?

One sentence, front-loaded with the resource and filter, with the only parenthetical earning its place by linking the output to the next tool. Nothing is redundant.

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 single-parameter read tool with no output schema, the description conveys what comes back (addable steps and their keys) and how to use them, which is the essential missing piece. A brief note on result ordering or whether the list is exhaustive would make it complete.

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 clientId parameter is fully documented in the schema, including its source (list_clients). The description implies client scoping but adds no format or sourcing detail beyond what the schema already provides, so the baseline 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 states a specific resource with a precise filter: onboarding steps that are not yet on a client's checklist and are therefore addable. That distinguishes it from get_client_onboarding (existing checklist) and add_client_onboarding_step (the mutation), though it never names those siblings outright.

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?

The parenthetical 'their keys feed add_client_onboarding_step' gives an explicit workflow: call this first to discover candidates, then feed a returned key to the add tool. There is no explicit exclusion or when-not guidance, but the ordering intent is unambiguous.

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.