Skip to main content
Glama
OtaKit

OtaKit

Official

Upload and publish an OtaKit bundle

upload_and_publish_bundle
Destructive

Upload a web bundle and publish it as an over-the-air update for Capacitor apps, with lane, compatibility, and idempotency controls.

Instructions

Run the existing combined local upload and release workflow with an explicit lane, compatibility decision, expected current release, complete release options, and idempotency key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appIdNoOtaKit app ID. Optional on a local connection whose project configures one; required otherwise.
channelYesNamed channel, or null for the base channel
encryptNoRequire encryption with OTAKIT_ENCRYPTION_KEY and fail if it is not set; bundles are encrypted whenever that variable is set
versionNoBundle version; defaults to OTAKIT_VERSION, then a generated one
strategyNozip uploads one archive; deltas uploads files separately so devices download only changed ones. Defaults to the project's updateStrategy, then zip
autoRevertNoEnable rollback-share based automatic revert for this release
sourcePathNoBuilt web assets directory in the project; defaults to Capacitor's webDir
versionModeNostrict requires version or OTAKIT_VERSION; auto (default) generates a version when neither is set
forceImmediateNoMake devices apply and reload on their next check
idempotencyKeyYesStable key reused only when retrying this exact mutation
replaceRolloutNoRevert the lane's active rollout and publish this bundle in its place
rolloutPercentNoShare of devices (1-100, default 100) that receive this release; below 100 starts a gradual rollout on a lane that already has a release
runtimeVersionNoNative runtime lane, or null for the default runtime
nodeModulesPathNonode_modules holding those dependencies; defaults to the one beside package.json
packageJsonPathNopackage.json that declares the app's native dependencies; defaults to the project root's
autoRevertMinSampleNoWith autoRevert: completed trials (applied plus rolled back) needed before the share is trusted (10-100000, default 50)
autoRevertRatePercentNoWith autoRevert: share of completed update trials that rolled back, over 24 hours, that triggers the revert (1-95, default 20)
compatibilityDecisionNoWhen the bundle's native dependencies differ from the lane's current release: block (default) refuses; proceed publishes anyway, only after confirming no store build is needed; skip does not compare
expectedCurrentReleaseIdYesRelease ID shown by prepare, or null when the lane had no release

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.9.1

TDQS

C2.8/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, idempotentHint=false and openWorldHint=true, so safety is covered. The description's only added behavioral content is that upload and publish happen together, which largely restates the tool name; it says nothing about the publish side effects, rollout behavior, or failure/partial-failure semantics for a destructive, open-world mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence with no wasted preamble, but the trailing enumeration ("complete release options") is filler that spends words without conveying meaning. It is compact rather than front-loaded with the information an agent actually needs.

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

Completeness2/5

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

For a 19-parameter destructive publish tool with no output schema, the description is far too thin: gradual rollout, auto-revert thresholds, encryption requirements, native-dependency compatibility blocking, and the concurrency guarantee from expectedCurrentReleaseId/idempotencyKey are all left to the schema. The description does not tie the required parameters back to the preflight tool (prepare_release/get_release_state) that supplies them.

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% across 19 parameters, so the schema already explains channel, compatibilityDecision, expectedCurrentReleaseId, rolloutPercent, autoRevert knobs and more. The description only gestures at them ("explicit lane, compatibility decision, expected current release") without adding syntax, defaults, or constraints, so the 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?

Names a specific composite action (combined local upload and release workflow), which implicitly distinguishes it from the sibling pair upload_bundle and publish_release. The phrasing "Run the existing ... workflow" is roundabout rather than a crisp verb+resource statement, but the upload+publish scope is conveyed.

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 and no mention of the obvious alternatives (upload_bundle, publish_release), even though this tool's whole reason to exist is that it combines them. An agent cannot tell from the description whether to prefer this over the two-step path.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.