whodb-cli

Official

Overview Schema Source Related Servers Discussions Admin

whodb_platform_workflow_get

Read-onlyIdempotent

Read a hosted WhoDB workflow plan and its step status without exposing payload values. Target a specific workspace host, org, and project per call.

Instructions

Read one hosted WhoDB workflow plan and its step status without returning payload values. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

Name	Required	Description	Default
`plan_id`	Yes	Workflow plan id
`workspace`	No	Optional 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

Name	Required	Description
`plan`	No
`error`	No
`plans`	No
`scope`	No
`status`	No
`message`	No
`commands`	No
`recovery`	No
`retryable`	No
`workspace`	No	Optional 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_code`	No
`next_steps`	No
`request_id`	No
`setup_status`	No
`suggested_tools`	No
`confirmation_token`	No
`confirmation_expiry`	No
`confirmation_required`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.136.0Oct 23, 2026
- 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"
```
Addedv0.135.0Oct 15, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent safety. The description adds real value beyond them by noting it omits payload values and that the workspace target applies per-call without mutating defaults — behaviors the annotations do not convey.

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?

Two tight sentences, front-loaded with the core action and the no-payload caveat, then the targeting detail. Nothing wasteful, though it could be slightly more compressed.

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

Completeness4/5

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

An output schema exists so return values need not be explained, and readOnly annotations cover safety; the description fills the remaining gap by clarifying no payload is returned and how workspace targeting scopes per call. Adequate for correct invocation.

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 coverage is 100%, so both plan_id and the nested workspace fields are already documented, including the 'does not change default host' note. The description reinforces the per-call semantics but largely restates what the schema already says, matching the baseline 3.

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 (read) plus resource (one hosted WhoDB workflow plan), and adds scope qualifiers (step status, no payload values) that distinguish it from the list/plan siblings. It doesn't explicitly name the closest alternative (whodb_platform_workflow_plan), so it stops short of a 5.

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 is implied by 'read one... plan' versus the list sibling, but there is no explicit when-to-use, when-not-to-use, or named alternative such as whodb_platform_workflow_list or whodb_platform_workflow_apply.

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

Deploy Server