Skip to main content
Glama
clidey

whodb-cli

Official
by clidey

whodb_platform_dataset

Read-onlyIdempotent

Retrieve details for a hosted dataset by ID, optionally scoping the call to a specific workspace host, org, or project and selecting only the output fields needed.

Instructions

Inspect one hosted dataset by id. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesResource id
fieldsNoTop-level output fields to include. Prefer only fields needed now; call again with more fields if needed.
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.135.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, so the safety profile is covered. The description adds that the workspace argument enables per-call targeting without changing defaults, which is useful behavioral context, but it does not describe return behavior, error cases, or limits.

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?

Two sentences, front-loaded with purpose then targeting behavior. There is no filler, and each sentence contributes a distinct piece of information.

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?

For a simple read-only inspection tool with rich annotations and full schema coverage, the description gives enough to invoke it correctly. The main remaining gap is that it does not clarify what 'inspect' returns, though the fields parameter and annotations make the output shape reasonably inferable.

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 id, fields, and workspace subfields. The description only repeats that the tool accepts an id and a workspace object; it adds no format, constraint, or selection detail 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: 'Inspect one hosted dataset by id.' The singular 'one hosted dataset' distinguishes it from list-oriented siblings like whodb_platform_datasets, but it does not explicitly name alternatives or contrast with whodb_platform_dataset_rows.

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?

There is no explicit when-to-use guidance, no prerequisites, and no named alternatives. The description implies use when you have a dataset id, but it does not say when to prefer this tool over whodb_platform_datasets or whodb_platform_dataset_rows.

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