Skip to main content
Glama

Create a new DRAFT onboarding flow

create_onboarding_draft

Creates a draft onboarding flow from a document you wrote (see get_onboarding_doc's reference). It is never made live: going live is done in the dashboard. Needs an MCP key that can edit.

Input Schema

NameRequiredDescriptionDefault
docYesA complete onboarding document
nameYesThe flow's name in the dashboard

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/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), it adds two genuinely useful facts: the flow is never made live here, and it requires an MCP key with edit permission. It omits what happens on name collision or whether the document is validated, but the safety/auth profile is well covered.

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 tight sentences with zero filler, and the key constraint (draft only, never live) is front-loaded. Nothing is repeated from the annotations or schema.

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

Completeness3/5

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

For a create mutation with no output schema and a free-form nested object, the description covers permissions and lifecycle but leaves the agent guessing about the return value (draft identifier?), validation of the supplied doc, and duplicate-name behavior. Adequate but with clear gaps.

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?

Schema coverage is 100%, so the baseline is 3; the description earns above that by pointing to get_onboarding_doc's reference for the free-form `doc` object, which the schema only describes as "A complete onboarding document" with additionalProperties {}. That pointer gives the agent real guidance on what to put in the opaque nested parameter.

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 ("Creates a draft onboarding flow") plus its source ("from a document you wrote") and explicitly marks the artifact as non-live. It is distinguishable from create_paywall_draft and get_onboarding_doc, though the boundary with save_onboarding_doc is left implicit.

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

Usage Guidelines3/5

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

The description clarifies that going live happens in the dashboard, which implies this tool's scope stops at draft creation, and it points to get_onboarding_doc for reference. However, it never says when to choose this over save_onboarding_doc or validate_onboarding_doc, so the routing guidance is only implied.

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