Skip to main content
Glama
whodb-cli

whodb-cli

Official
by clidey

whodb_platform_workflow_plan

Read-onlyIdempotent

Validate and persist multi-step hosted WhoDB workflows without executing writes, enabling end-to-end goals such as source-to-dataset-to-transform-to-app planning.

Instructions

Validate and persist a multi-step hosted WhoDB workflow without executing writes. Use this for end-to-end goals such as source to dataset to transform to app. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

NameRequiredDescriptionDefault
goalYesDesired end state for this hosted platform workflow
stepsYesOrdered hosted platform writes to validate and execute
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.1/5.0
Behavior1/5

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

Annotations declare readOnlyHint=true and idempotentHint=true, but the description says the tool will 'persist' a workflow, which implies storing/mutating state. 'Without executing writes' only rules out downstream execution writes, not persisting the plan itself, so the description conflicts with the read-only annotation.

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?

The description is three sentences, front-loaded with the core operation, then use case and workspace behavior. There is no filler.

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?

An output schema and complete parameter schemas exist, so return and parameter details need not be repeated. But for a workflow-planning tool, the description does not clarify what 'persist' means operationally, nor how this relates to workflow_apply, leaving key behavioral context ambiguous.

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%, so the schema already documents goal, steps, and workspace fully. The description restates the workspace targeting behavior and gives an example workflow shape, but adds no new syntax or constraints beyond the schema.

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 verb and resource: validate and persist a multi-step hosted WhoDB workflow without executing writes. It also supplies an end-to-end example. It does not explicitly name the execution sibling workflow_apply, and 'persist' makes the purpose slightly muddy.

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?

It gives a clear use case ('end-to-end goals such as source to dataset to transform to app') and implies it is not the execution tool ('without executing writes'). However, it never explicitly states when to use this versus workflow_apply or another planning sibling, nor any exclusions or prerequisites.

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