whodb-cli

Official

Overview Schema Source Related Servers Discussions Admin

whodb_platform_source_columns

Read-onlyIdempotent

Describe columns for a hosted WhoDB source object using a source name or ID plus an object ref like table:public.users, with optional workspace targeting for that call.

Instructions

Describe columns for one hosted WhoDB source object.

Use a source name or id and an object ref such as table:public.users. This tool is read-only. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

Name	Required	Description
`ref`	Yes	Object ref as kind:path, for example table:public.users
`fields`	No	Optional top-level output fields to include in items
`source`	Yes	Hosted source id or name
`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
`count`	Yes
`error`	No
`items`	No
`scope`	No
`fields`	No
`columns`	Yes
`commands`	No
`recovery`	No
`warnings`	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

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

B3.2/5.0

Behavior3/5

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

The 'This tool is read-only' sentence duplicates the readOnlyHint annotation and earns no credit, and idempotentHint/openWorldHint already cover re-safety. What the description genuinely adds is the per-call workspace targeting nuance ('without changing defaults'), which clarifies that passing workspace does not mutate session state. With annotations already carrying the safety profile, a 3 is appropriate.

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 short sentences, front-loaded with the action and resource, with no filler. Minor redundancy: the read-only claim repeats annotations and the ref example repeats the schema.

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 and full annotation coverage, the description need not explain return values, and it doesn't have to. What is missing is the connective tissue: how to obtain a valid 'kind:path' ref and how this tool relates to the sibling fields/objects tools, in a tool family where those names are easily confused.

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 source, ref, fields, and the nested workspace object are all documented in the schema itself. The description restates the ref example already in the schema and adds only the mild clarification that workspace targeting is per-call; baseline 3 is correct when the schema does the heavy lifting.

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: 'Describe columns for one hosted WhoDB source object.' An agent knows this returns column metadata for a single object. However, it does not differentiate from the very similarly named sibling whodb_platform_source_fields (or source_objects / source_rows), leaving the columns-vs-fields boundary to guesswork.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is described only in terms of arguments ('Use a source name or id and an object ref such as table:public.users'), which merely restates the schema. There is no guidance on when to pick this over whodb_platform_source_fields or whodb_platform_source_objects, and no hint that object refs are discovered via the objects-list tool.

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

Deploy Server