Skip to main content
Glama
whodb-cli

whodb-cli

Official
by clidey

whodb_platform_workflow_apply

Destructive

Applies or resumes a hosted WhoDB workflow plan, skipping completed steps on retry and optionally targeting a workspace per call.

Instructions

Request confirmation to apply or resume a hosted WhoDB workflow plan. Completed steps are skipped on retry. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

NameRequiredDescriptionDefault
plan_idYesWorkflow plan id returned by whodb_platform_workflow_plan
workspaceNoOptional target for this call only. Omit to use the session default set by whodb_platform_session_use, then process/saved defaults. Discover targets with whodb_platform_hosts, whodb_platform_orgs and whodb_platform_projects.

Output Schema

NameRequiredDescriptionDefault
planNo
errorNo
plansNo
scopeNo
statusNo
messageNo
commandsNo
recoveryNo
retryableNo
workspaceNoOptional target for this call only. Omit to use the session default set by whodb_platform_session_use, then process/saved defaults. Discover targets with whodb_platform_hosts, whodb_platform_orgs and whodb_platform_projects.
error_codeNo
next_stepsNo
request_idNo
setup_statusNo
suggested_toolsNo
confirmation_tokenNo
confirmation_expiryNo
confirmation_requiredNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.136.0
    • changedOutput schema / properties / recovery / type
      Previous value: -[
      -  "null",
      -  "object"
      -]New value: +"object"
    • changedOutput schema / properties / suggested_tools / type
      Previous value: -[
      -  "null",
      -  "array"
      -]New value: +"array"
  2. Addedv0.135.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, openWorldHint=true, idempotentHint=false, so the safety profile is covered. The description adds genuinely new behavior — that completed steps are skipped on resume and that workspace targeting is per-call without mutating defaults. However, it never warns that applying is destructive and may not be reversible, which is the most important thing an agent should know here.

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?

Three tight sentences with the action front-loaded, followed by retry semantics and targeting. The final sentence mostly duplicates the workspace parameter description in the schema, making it the one sentence that does not fully earn its place.

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?

With an output schema present, return values need not be explained, and the single required parameter is documented in the schema. What is missing is the operational context for a destructive, non-idempotent action: what state it mutates, whether it can be undone, and how it relates to the confirm/plan siblings.

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 nested workspace object already documents host/org/project, including fallback ordering via session defaults. The description's 'workspace {host, org, project} ... without changing defaults' largely restates the schema's own wording, so it adds no syntax or constraint detail beyond it.

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 pair (apply or resume) and resource (hosted WhoDB workflow plan), which cleanly separates it from whodb_platform_workflow_plan (builds the plan) and whodb_platform_workflow_get/list. The phrase 'Request confirmation to apply' leaves slight ambiguity about whether this tool executes or merely stages a confirmation, given a sibling named whodb_platform_confirm.

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?

Usage context is implied rather than spelled out: apply/resume a plan that was produced by a prior planning step. It never names the prerequisite tool (whodb_platform_workflow_plan) or the relation to whodb_platform_confirm, and gives no when-not guidance. 'Completed steps are skipped on retry' is useful retry guidance but is behavioral, not selection guidance.

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