Skip to main content
Glama

Save a DRAFT onboarding flow's document

save_onboarding_doc
Destructive

Replaces a draft flow's document with the one given, as a new version (the dashboard's history shows it as mcp: <note> and can roll it back). Refused for a live flow. Needs an MCP key that can edit. Translations, overrides and the exit setting are kept.

Input Schema

NameRequiredDescriptionDefault
idYesThe draft flow's id
docYesThe complete edited document
noteNoWhat changed, for the version history

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well past the annotations: it explains the write is versioned rather than a blind overwrite, that history labels it `mcp: <note>` and can roll back, that live flows are rejected, and that translations, overrides and the exit setting survive. The destructiveHint=true is consistent with 'replaces' and is softened coherently by the versioning/rollback detail, so there is no contradiction.

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 short sentences with no filler; the destructive replace behavior is front-loaded and the caveats (live-flow refusal, key requirement, preserved data) follow in a logical order.

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 destructive, nested-object mutation with no output schema, the description covers reversibility, permissions, rejection conditions and side-effect preservation. Nothing an agent needs in order to invoke it safely appears to be missing.

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, but the description adds meaning the schema doesn't: 'doc' must be the complete document (a replace, not a patch) and 'note' surfaces in version history with an `mcp:` prefix. That clarifies how to fill both required and optional params.

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 ('Replaces a draft flow's document') with the scope qualifier 'draft', which cleanly separates it from save_paywall_doc and from the editor_* pair. An agent can identify the tool and its target object without opening the schema.

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 an explicit exclusion ('Refused for a live flow') and a prerequisite ('Needs an MCP key that can edit'), which is real guidance beyond the name. It stops short of naming the alternative to use for live flows or the validate_onboarding_doc / get_onboarding_doc siblings, so it is not a full 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.

Resources