Skip to main content
Glama
whodb-cli

whodb-cli

Official
by clidey

whodb_platform_source_rows

Read-onlyIdempotent

Preview rows from a hosted WhoDB source object by specifying the source and an object ref such as table:public.users; read-only results respect row limits and offsets.

Instructions

Preview rows for one hosted WhoDB source object.

Use a source name or id and an object ref such as table:public.users. Results are capped by the requested limit and the MCP --max-rows setting when provided. This tool is read-only. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

NameRequiredDescriptionDefault
refYesObject ref as kind:path, for example table:public.users
limitNoMaximum rows to return
offsetNoRow offset
sourceYesHosted source id or name
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
rowsYes
errorNo
scopeNo
totalYes
columnsYes
commandsNo
recoveryNo
retryableNo
truncatedYes
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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.136.0
    • 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"
      +}
  2. Addedv0.135.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover read-only and idempotency, but the description adds real context: results are capped by both the requested limit and the MCP --max-rows setting, and a per-call workspace can be supplied without mutating session defaults. That cap interaction is exactly the kind of behavior an agent cannot infer from structured fields.

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?

Four short sentences, front-loaded with the purpose, with no repetition of the schema and no filler. The cap and targeting caveats are stated compactly in their own sentences.

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 no explanation, and the description covers the read-only nature, the limit ceiling, and workspace scoping. Minor gap: no mention of offset/pagination behavior or error cases for an invalid ref, but the essentials are covered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description still adds value by clarifying that source accepts either an id or a name and by explaining that limit interacts with the server-side --max-rows ceiling. It also clarifies that workspace applies to this call only and does not change defaults.

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 and resource: preview rows for one hosted source object. It is naturally distinguishable from siblings such as whodb_platform_source_objects and whodb_platform_source_columns, though it never names an alternative to sharpen the boundary.

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?

The description explains how to call it (source name or id plus an object ref like table:public.users) but gives no explicit guidance on when to choose this over whodb_platform_dataset_rows, whodb_platform_source_content, or other row-reading siblings, and no when-not conditions.

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