whodb-cli

Official

Overview Schema Source Related Servers Discussions Admin

whodb_platform_setup_status

Read-onlyIdempotent

Checks hosted WhoDB MCP setup before auth-dependent tools, reports login and organization/project selection, and returns exact commands to fix login or workspace errors.

Instructions

Check hosted WhoDB MCP setup before auth-dependent tools.

Use this as the first tool in hosted platform mode, or whenever another platform tool reports login/workspace errors. It does not require a valid hosted session. It reports whether the local CLI is logged in, whether an organization/project is selected, and exact commands the user can run to fix setup. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

Name	Required	Description	Default
`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
`host`	Yes
`email`	No
`error`	No
`scope`	No
`org_id`	No
`status`	Yes
`commands`	Yes
`org_name`	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.
`account_id`	No
`error_code`	No
`next_steps`	Yes
`project_id`	No
`request_id`	No
`org_selector`	No
`project_name`	No
`authenticated`	Yes
`session_scope`	No
`suggested_tools`	No
`project_selector`	No
`workspace_selected`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedv0.136.0Oct 23, 2026

addedOutput schema / properties / error_code
```
Added value: +{
+  "type": "string"
+}
```

addedOutput schema / properties / recovery

Added value: +{
+  "additionalProperties": false,
+  "properties": {
+    "LikelyCause": {
+      "type": "string"
+    },
+    "NextSteps": {
+      "items": {
+        "type": "string"
+      },
+      "type": [
+        "null",
+        "array"
+      ]
+    }
+  },
+  "required": [
+    "LikelyCause",
+    "NextSteps"
+  ],
+  "type": "object"
+}

addedOutput schema / properties / retryable
```
Added value: +{
+  "type": "boolean"
+}
```

addedOutput schema / properties / suggested_tools

Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

Addedv0.135.0Oct 15, 2026

TDQS

A4.1/5.0

Behavior5/5

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

Beyond the readOnly/openWorld/idempotent annotations, the description discloses that no valid hosted session is required, what setup states are reported, and that exact remediation commands are returned. It also explains that workspace targeting applies only to the current call without changing defaults.

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?

The description is front-loaded and each sentence contributes useful information about usage, auth requirements, reported status, and workspace targeting. There is minor repetition between the opening preflight framing and the second sentence's 'first tool' guidance.

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?

Given that an output schema exists and the input schema has full description coverage, the description supplies enough context to call the tool correctly: when to use it, that it works without a hosted session, what it reports, and how workspace targeting behaves. No critical invocation details are missing.

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 workspace, host, org, and project semantics are already well documented in the schema. The description restates the per-call targeting behavior but adds little beyond what the schema already provides, making 3 the appropriate baseline.

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: checking hosted WhoDB MCP setup. It distinguishes this preflight check from auth-dependent platform tools and error recovery, though it does not explicitly differentiate from similar siblings such as whodb_platform_status or whodb_platform_doctor.

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?

It clearly says to use this as the first tool in hosted platform mode and whenever another platform tool reports login/workspace errors. It lacks explicit when-not-to-use guidance or named alternative tools, so it falls short of the top score.

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

Deploy Server