Skip to main content
Glama
clidey

whodb-cli

Official
by clidey

whodb_platform_bundle_export

Read-onlyIdempotent

Export selected hosted project metadata as a portable bundle for backup or migration, with per-call workspace targeting. Secret values are excluded, and files can be included up to a byte cap.

Instructions

Export selected hosted project metadata as a portable bundle.

The bundle includes metadata for secrets, datasets, ontologies, transforms, functions, folders, and files. Secret values are never exported. File content is only exported when include_files is true and is capped by max_file_bytes. Accepts workspace {host, org, project} for per-call targeting without changing defaults.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
include_filesNoInclude previewable uploaded file content up to max_file_bytes per file
max_file_bytesNoMaximum bytes to include per uploaded file when include_files is true

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNo
scopeNo
bundleNo
countsNo
commandsNo
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.
next_stepsNo
request_idNo
setup_statusNo

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 readOnlyHint/idempotentHint/openWorldHint, but the description adds genuinely additive behavior: secret values are never exported, and file content is conditional on include_files and capped by max_file_bytes. It stops short of covering scale limits, auth/permission needs, or the bundle's output format.

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 tight sentences, purpose front-loaded, and each subsequent sentence adds a distinct fact (contents, redaction, file gating, workspace scoping). No filler.

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 read-only export with a full schema and an output schema, the description covers what matters: scope, redaction, and file-size behavior. Minor gaps remain (bundle format/serialization, permission requirements) but the agent has enough to invoke it correctly.

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, but the description adds real meaning by tying include_files and max_file_bytes together and clarifying that workspace targeting is per-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 (Export) and resource (hosted project metadata as a portable bundle) and enumerates exactly which resource types are included (secrets, datasets, ontologies, transforms, functions, folders, files). It does not explicitly name or distinguish the closely related siblings bundle_import/bundle_diff, so it falls just short of the top tier.

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?

Usage is only implied — the word 'Export' suggests the direction, but the description never says when to choose this over whodb_platform_bundle_diff or whodb_platform_bundle_import, nor states prerequisites (e.g. requiring a resolved workspace).

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