Skip to main content
Glama

Onboarding Plan

onboarding_plan
Read-onlyIdempotent

Decide how many onboarding steps to use for a quiz-style iOS subscription app by returning recommended ranges and step-count guidance without modifying files.

Instructions

Return guidance for choosing the onboarding step count; does not change any file.

Use when: deciding onboarding length with the user (quiz-style flow with about 5 personalization questions is the standard). Returns: {ok, step_count, ranges: {"8-10"|"11-13"|"14-15": description}, warning?}.

Input Schema

NameRequiredDescriptionDefault
step_countNoDesired number of onboarding steps; recommended range 8-15 (default 12).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.5
    • addedInput schema / properties / step_count / description
      Added value: +"Desired number of onboarding steps; recommended range 8-15 (default 12)."
  2. First observedv0.1.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, and the description's 'does not change any file' largely restates readOnlyHint. It does add the shape of the returned ranges, but since an output schema exists that is modest incremental value.

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?

Front-loaded and cleanly segmented into purpose, 'Use when:', and 'Returns:' with no filler. The returns sentence is slightly redundant given the output schema, keeping it just under a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter, read-only guidance tool with full schema coverage, annotations, and an output schema, the description covers what the tool does, when to invoke it, and that it is safe — nothing an agent needs is missing.

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 100% and the single step_count parameter is fully documented there (including default 12 and 8-15 range). The description adds no format or constraint detail beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Return guidance for choosing the onboarding step count') and immediately scopes it as non-mutating ('does not change any file'). No sibling covers anything similar, so the agent can identify it unambiguously.

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 'Use when:' clause gives a clear trigger context (deciding onboarding length with the user) and even adds a default scenario (quiz-style flow with about 5 questions). It stops short of naming when *not* to use it or an alternative tool, so it is clear context without exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools