Skip to main content
Glama
clidey

whodb-cli

Official
by clidey

whodb_platform_update

Destructive

Update hosted platform resources like datasets, secrets, or functions via selected project. Provide resource ID and changed fields; get a confirmation token before applying.

Instructions

Update a hosted platform resource through the selected project.

Supported resources: secret, ai_provider, ontology, dataset, transform, function, app, lineage_provider, source_object. Pass id when required and payload_json with changed fields only. Secret-like payload fields are never shown in confirmation previews. Default mode returns a confirmation token; do not call whodb_platform_confirm until the user approves the preview. Permission checks are enforced by the hosted platform. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoResource id for update, delete, or action operations
actionNoAction name for whodb_platform_action, for example deploy, run, rename, move, promote_to_dataset
payloadNoStructured mutation payload. Do not include projectId or the target id; the selected workspace and id are injected by the CLI.
resourceYesResource type, for example secret, ai_provider, ontology, dataset, transform, folder, file, function, source_object
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.
payload_jsonNoLegacy JSON object payload. Prefer payload; projectId and id are filled from selected workspace/id when appropriate.
idempotency_keyNoStable caller-provided key. Repeating a successful write with the same key will not execute it again.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 declare destructiveHint=true, idempotentHint=false, and openWorldHint=true. The description adds high-value context beyond annotations: the confirmation-token flow, the secret-like field masking in previews, and per-call workspace targeting.

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?

Front-loaded with the core verb and resource types, followed by workflow constraints. The enumerated resource list is somewhat long but serves selection. Minor redundancy between 'payload' and 'payload_json' guidance.

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?

Given 7 parameters, nested workspace object, no output schema, and destructive semantics, the description covers the confirmation flow, payload conventions, and targeting. It omits return shape and error behavior, but the confirmation-token mention covers the key behavioral unknown.

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 all 7 parameters are already documented in the schema. The description reinforces id, payload_json, and workspace semantics but adds little beyond what the schema provides.

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 (Update) and resource (hosted platform resource), and enumerates the supported resource types. It does not differentiate from sibling whodb_platform_action or whodb_platform_create, but the purpose is immediately clear.

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 gives explicit workflow guidance: pass id when required, use payload_json with changed fields only, and do not call whodb_platform_confirm until the user approves. However, it doesn't explain when to prefer this tool over whodb_platform_create or whodb_platform_action.

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