Skip to main content
Glama
whodb-cli

whodb-cli

Official
by clidey

whodb_platform_bundle_export

Read-onlyIdempotent

Export selected hosted project metadata as a portable bundle for backup or migration, including datasets, transforms, functions, and files. Secret values are excluded; file content is optional.

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

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

NameRequiredDescriptionDefault
errorNo
scopeNo
bundleNo
countsNo
commandsNo
recoveryNo
retryableNo
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. Changed12 schema fields changedv0.136.0
    • addedOutput schema / properties / bundle / properties / functions / items / properties / scheduleCron
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / bundle / properties / functions / items / properties / scheduleInput
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / bundle / properties / functions / items / properties / scheduleLastRunAt
      Added value: +{
      +  "type": [
      +    "null",
      +    "string"
      +  ]
      +}
    • addedOutput schema / properties / bundle / properties / functions / items / properties / scheduleVersion
      Added value: +{
      +  "type": "integer"
      +}
    • changedOutput schema / properties / bundle / properties / functions / items / required
      Previous value: -[
      -  "id",
      -  "projectId",
      -  "name",
      -  "description",
      -  "language",
      -  "entryPoint",
      -  "timeoutSeconds",
      -  "memory",
      -  "cpu",
      -  "createdBy",
      -  "createdAt",
      -  "updatedAt",
      -  "files",
      -  "dependencies",
      -  "providerIds",
      -  "ontologyIds",
      -  "readOnlyOntologyIds",
      -  "providerConfigs",
      -  "secretBindings",
      -  "defaultMaxTokens",
      -  "defaultTemperature",
      -  "isDeployed"
      -]New value: +[
      +  "id",
      +  "projectId",
      +  "name",
      +  "description",
      +  "language",
      +  "entryPoint",
      +  "timeoutSeconds",
      +  "memory",
      +  "cpu",
      +  "createdBy",
      +  "createdAt",
      +  "updatedAt",
      +  "files",
      +  "dependencies",
      +  "providerIds",
      +  "ontologyIds",
      +  "readOnlyOntologyIds",
      +  "providerConfigs",
      +  "secretBindings",
      +  "defaultMaxTokens",
      +  "defaultTemperature",
      +  "isDeployed",
      +  "scheduleCron",
      +  "scheduleInput",
      +  "scheduleVersion"
      +]
    • addedOutput schema / properties / bundle / properties / ontologies / items / properties / links / items / properties / targetKind
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / bundle / properties / ontologies / items / properties / links / items / properties / targetReferenceId
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / properties / bundle / properties / ontologies / items / properties / links / items / required
      Previous value: -[
      -  "id",
      -  "apiName",
      -  "targetOntologyApiName",
      -  "cardinality",
      -  "foreignKeyProperty",
      -  "targetForeignKeyProperty",
      -  "joinTable",
      -  "sourceColumnInJoinTable",
      -  "targetColumnInJoinTable",
      -  "displayName",
      -  "pluralDisplayName",
      -  "reverseDisplayName"
      -]New value: +[
      +  "id",
      +  "apiName",
      +  "targetOntologyApiName",
      +  "cardinality",
      +  "foreignKeyProperty",
      +  "targetForeignKeyProperty",
      +  "joinTable",
      +  "sourceColumnInJoinTable",
      +  "targetColumnInJoinTable",
      +  "displayName",
      +  "pluralDisplayName",
      +  "reverseDisplayName",
      +  "targetKind",
      +  "targetReferenceId"
      +]
    • 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.8/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/openWorld, and the description adds real behavioral context beyond them: secret values are never exported, file content is only included when include_files is true, and it is capped by max_file_bytes. It does not describe output shape or size, but the presence of an output schema reduces that burden.

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?

Four short sentences with the purpose front-loaded and no filler. The final sentences largely restate schema parameter descriptions, which is slight redundancy but not wasteful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-parameter export tool with an output schema and full annotation coverage, the description supplies what is needed: what gets exported, what never gets exported, when file content is included, and how targeting works. Nothing an agent needs to invoke it correctly is missing.

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%, and the nested workspace object is fully documented in the schema, including the resolution order of session default then process/saved defaults. The description restates the include_files/max_file_bytes gating rather than adding syntax or format details, so baseline 3 applies.

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 uses a specific verb and resource: "Export selected hosted project metadata as a portable bundle," and enumerates the resource classes included (secrets, datasets, ontologies, transforms, functions, folders, files). It does not explicitly point to siblings like whodb_platform_bundle_import or whodb_platform_bundle_diff, so differentiation relies on the tool name.

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 says the workspace arg allows per-call targeting without changing defaults, which implies usage, but it never states when an agent should choose this over bundle_diff, bundle_import, or clone. There is no explicit when/when-not guidance or prerequisites.

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