authenticate

CALL THIS IMMEDIATELY AFTER get_auth_challenge. Submit the base58 signature of the challenge message to unlock the session. All deploy/build/status tools require authentication — do not call them until this succeeds.

Argument	Type	Description
signature*	string	Base58 ed25519 signature of challengeMessage, signed locally off-chain
walletAddress*	string	Same wallet address used in get_auth_challenge

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "walletAddress",
    "signature"
  ],
  "properties": {
    "signature": {
      "type": "string",
      "description": "Base58 ed25519 signature of challengeMessage, signed locally off-chain"
    },
    "walletAddress": {
      "type": "string",
      "description": "Same wallet address used in get_auth_challenge"
    }
  }
}

build_image

USE ONLY when you want to build a container image WITHOUT creating a deployment. For normal shipping, prefer deploy_app instead (build + deploy in one step). Call this if you need to verify the image builds successfully before deploying, or if you plan to deploy the image manually later. After calling, poll get_build_status until SUCCESS. Prefer validate_upload first.

Argument	Type	Description
files*	object	Complete local project files (path → content). Must include required paths (see list_template_files). Omit package-lock.json. Test with npm run build locally first.
appName*	string	Application name — becomes part of the Artifact Registry image tag
mergeMode	string	strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).
templateId*	string	From list_templates (e.g. webapp-static). Required — provides build defaults.
buildCommand	string	Override template default (webapp-static: npm run build)
startCommand	string	Override template default (webapp-static production: npm start → serve -s dist)
dockerfileContent	string	Only if you need a custom Dockerfile instead of buildpacks

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "appName",
    "templateId",
    "files"
  ],
  "properties": {
    "files": {
      "type": "object",
      "description": "Complete local project files (path → content). Must include required paths (see list_template_files). Omit package-lock.json. Test with npm run build locally first.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "appName": {
      "type": "string",
      "description": "Application name — becomes part of the Artifact Registry image tag"
    },
    "mergeMode": {
      "enum": [
        "strict",
        "scaffold"
      ],
      "type": "string",
      "default": "strict",
      "description": "strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings)."
    },
    "templateId": {
      "type": "string",
      "description": "From list_templates (e.g. webapp-static). Required — provides build defaults."
    },
    "buildCommand": {
      "type": "string",
      "description": "Override template default (webapp-static: npm run build)"
    },
    "startCommand": {
      "type": "string",
      "description": "Override template default (webapp-static production: npm start → serve -s dist)"
    },
    "dockerfileContent": {
      "type": "string",
      "description": "Only if you need a custom Dockerfile instead of buildpacks"
    }
  }
}

close_app

CALL THIS WHEN PERMANENTLY SHUTTING DOWN an app — stops the Akash lease, frees resources, and marks the deployment DELETED. This is irreversible for that deploymentId. Use list_apps first if you don't know the ID. Do NOT use this for updates — use update_app instead.

Argument	Type	Description
deploymentId*	string	deploymentId to tear down (from deploy_app, get_app_status, or list_apps)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "deploymentId"
  ],
  "properties": {
    "deploymentId": {
      "type": "string",
      "description": "deploymentId to tear down (from deploy_app, get_app_status, or list_apps)"
    }
  }
}

deploy_app

PRIMARY SOURCE DEPLOY TOOL — call when the app is built/tested locally and ready to ship. Prefer validate_upload first. Uploads files + templateId (mergeMode=strict by default: upload-as-is — never injects starter Tailwind/PostCSS/React files; requires package.json + index.html and that the HTML entry's local imports resolve). Framework-agnostic SPA. Returns uploadSummary + warnings. Next: poll get_app_status until ACTIVE and httpReady=true, then share proxyUri. Apps are unlisted by default (live URL still works); pass listOnStore=true or call set_app_listing to appear on the App Store. Omit package-lock.json. Use deploy_image for prebuilt images. See prompt deploy_app_guide.

Argument	Type	Description
port	number	Container listen port (webapp-static default: 3000)
files*	object	Complete local project files including all required paths (list_template_files). Omit package-lock.json. Must pass local npm run build first.
appName*	string	Unique app name used for the image tag and My Apps
imageUrl	string	Preview/thumbnail URL for the app card in the store
mergeMode	string	strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).
templateId*	string	From list_templates (e.g. webapp-static). Must match how the app was scaffolded.

deploy_image

CALL THIS WHEN YOU ALREADY HAVE A PUBLIC DOCKER/OCI IMAGE and want to deploy it to devnet without uploading source files or running Cloud Build. Requires dockerImage + appName. Use deploy_app instead when the agent has local source files and wants ShipDapp to build the image. Guardrails apply: max active deployments, daily limit, duplicate appName blocked, hourly deploy rate limit, cooldown. Returns deploymentId, network=devnet, dockerImage. Apps are unlisted by default; pass listOnStore=true or call set_app_listing to appear on the App Store. Next step: poll get_app_status until ACTIVE and share proxyUri.

Argument	Type	Description
port	number	Container listen port (default: 3000)
appName*	string	Unique app name shown in My Apps
imageUrl	string	Preview/thumbnail URL for the app card in the store
description	string	Short description shown on the app listing when listed
dockerImage*	string	Public container image URI, e.g. ghcr.io/acme/my-app:latest or docker.io/library/nginx:alpine
listOnStore	boolean	If true, list this app on the public App Store. Default false (unlisted; proxyUri still works).
startCommand	string	Optional command override if the image needs one

get_app_status

PRIMARY STATUS POLL after deploy_app, update_app, or deploy_image. Poll every 10–20s until status is ACTIVE and httpReady is true (then share proxyUri), or FAILED (read lastError / buildLogTail). ACTIVE alone can still mean HTTP 503 while the process starts — wait for httpReady. On FAILED, buildLogTail may be attached automatically.

Argument	Type	Description
deploymentId*	string	deploymentId from deploy_app response, or pick from list_apps

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "deploymentId"
  ],
  "properties": {
    "deploymentId": {
      "type": "string",
      "description": "deploymentId from deploy_app response, or pick from list_apps"
    }
  }
}

get_auth_challenge

CALL THIS FIRST before deploy/build tools ONLY if you are NOT using a ShipDapp API key in MCP client headers. Returns a Sign-In-With-Solana message for local wallet signing.

Argument	Type	Description
walletAddress*	string	Solana wallet public key (base58), e.g. from ~/.config/solana/id.json

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "walletAddress"
  ],
  "properties": {
    "walletAddress": {
      "type": "string",
      "description": "Solana wallet public key (base58), e.g. from ~/.config/solana/id.json"
    }
  }
}

get_build_status

Optional debug tool for Cloud Build progress. Prefer polling get_app_status(deploymentId) after deploy_app/update_app — the server auto-promotes BUILDING → Akash deploy when the build succeeds. Use this when you only have a buildId (e.g. after build_image) or need build-level detail. On FAILURE, returns failureSummary and buildLogTail when available.

Argument	Type	Description
buildId*	string	buildId from build_image, deploy_app, or file-based update_app response
deploymentId	string	Optional. If omitted and this build belongs to a BUILDING deployment, the server still auto-starts Akash deploy on SUCCESS.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "buildId"
  ],
  "properties": {
    "buildId": {
      "type": "string",
      "description": "buildId from build_image, deploy_app, or file-based update_app response"
    },
    "deploymentId": {
      "type": "string",
      "description": "Optional. If omitted and this build belongs to a BUILDING deployment, the server still auto-starts Akash deploy on SUCCESS."
    }
  }
}

get_logs

CALL THIS WHEN SOMETHING WENT WRONG or you need to debug. type=build + buildId: after FAILURE — returns failureSummary and inline buildLogTail when Cloud Logging is available (else logUrl). type=runtime: container stdout/stderr from Akash when ACTIVE; on provider HTTP errors, returns a clear message plus lastError fallback. Runtime logs are NOT available until the deployment has an Akash lease.

Argument	Type	Description
tail	number	Max approximate log lines for runtime logs (default 500)
type	string	build = GCB build logs (needs buildId). runtime = live container logs (needs ACTIVE deployment)
buildId	string	Required when type=build — from deploy_app or build_image response
deploymentId*	string	deploymentId from deploy_app or list_apps

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "deploymentId"
  ],
  "properties": {
    "tail": {
      "type": "number",
      "description": "Max approximate log lines for runtime logs (default 500)"
    },
    "type": {
      "enum": [
        "build",
        "runtime"
      ],
      "type": "string",
      "default": "runtime",
      "description": "build = GCB build logs (needs buildId). runtime = live container logs (needs ACTIVE deployment)"
    },
    "buildId": {
      "type": "string",
      "description": "Required when type=build — from deploy_app or build_image response"
    },
    "deploymentId": {
      "type": "string",
      "description": "deploymentId from deploy_app or list_apps"
    }
  }
}

get_usage_limits

CALL THIS AFTER A GUARDRAIL BLOCK or before planning multiple deploys. Returns your wallet's deployment quotas and current usage (active apps, hourly build/deploy counts). Use to understand why deploy_app was rejected and what to do next (close_app or wait).

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_apps

CALL THIS to see all your deployed apps (listed and unlisted), find a deploymentId, or check which apps are ACTIVE vs DEPLOYING. Use before update_app, set_app_listing, or close_app when you don't know the deploymentId.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_template_files

CALL THIS BEFORE deploy_app to see required vs optional paths. Required is minimal (package.json + index.html); component filenames are not fixed — validate_upload checks that the HTML entry's imports resolve.

Argument	Type	Description
appName	string	Optional — only affects scaffold content, not path lists
templateId*	string	From list_templates (e.g. webapp-static)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "templateId"
  ],
  "properties": {
    "appName": {
      "type": "string",
      "description": "Optional — only affects scaffold content, not path lists"
    },
    "templateId": {
      "type": "string",
      "description": "From list_templates (e.g. webapp-static)"
    }
  }
}

list_templates

CALL THIS WHEN STARTING A NEW APP or when you need a templateId for deploy_app/build_image. Returns available templates (e.g. webapp-static = frontend SPA, framework-agnostic). Optional starter via includeFiles=true is React+Vite+Tailwind — not required. Production start uses serve -s dist in the starter. Prefer list_template_files + validate_upload before deploy_app. Upload your complete project as-is (mergeMode=strict never injects Tailwind/PostCSS).

Argument	Type	Description
appName	string	Substituted into template files like index.html title (default: my-app)
includeFiles	boolean	Set true when bootstrapping a new project — returns scaffold files to write to disk

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "appName": {
      "type": "string",
      "description": "Substituted into template files like index.html title (default: my-app)"
    },
    "includeFiles": {
      "type": "boolean",
      "default": false,
      "description": "Set true when bootstrapping a new project — returns scaffold files to write to disk"
    }
  }
}

set_app_listing

CALL THIS to list or unlist an existing app on the public App Store. Unlisted apps stay reachable via proxyUri if you know the URL. Use list_apps to find deploymentId. Does not change the live deployment.

Argument	Type	Description
listed*	boolean	true = appear on App Store; false = unlisted (private from discovery)
deploymentId*	string	deploymentId from deploy_app, deploy_image, or list_apps

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "deploymentId",
    "listed"
  ],
  "properties": {
    "listed": {
      "type": "boolean",
      "description": "true = appear on App Store; false = unlisted (private from discovery)"
    },
    "deploymentId": {
      "type": "string",
      "description": "deploymentId from deploy_app, deploy_image, or list_apps"
    }
  }
}

update_app

CALL THIS WHEN AN APP IS ALREADY DEPLOYED and you want to push new code or change config. Pass files + templateId to rebuild (same strict upload rules as deploy_app — prefer validate_upload first), OR pass dockerImage alone to redeploy an existing image. Do NOT use deploy_app for updates. Blocked while status is DEPLOYING — wait and poll get_app_status. After calling, poll until ACTIVE and httpReady=true.

Argument	Type	Description
port	number	Change container port (optional)
files	object	New local files — triggers a cloud rebuild before redeploying
appName	string	Rename the app (optional)
mergeMode	string	strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).
templateId	string	Required when files is provided — same template used originally
description	string	Update the app description (optional)
dockerImage	string	Pre-built image URI — use instead of files when image is already built
buildCommand	string

validate_upload

DRY-RUN before deploy_app/update_app/build_image. Checks file count, bytes, missing required paths, template-default fills, and placeholder garbage — without starting a Cloud Build. Call this when unsure the files map is complete.

Argument	Type	Description
files*	object	Same files map you would pass to deploy_app
appName	string
mergeMode	string	strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).
templateId*	string	From list_templates (e.g. webapp-static)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "templateId",
    "files"
  ],
  "properties": {
    "files": {
      "type": "object",
      "description": "Same files map you would pass to deploy_app",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "appName": {
      "type": "string"
    },
    "mergeMode": {
      "enum": [
        "strict",
        "scaffold"
      ],
      "type": "string",
      "default": "strict",
      "description": "strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings)."
    },
    "templateId": {
      "type": "string",
      "description": "From list_templates (e.g. webapp-static)"
    }
  }
}

ShipDapp

Try it

authenticate

ShipDapp

Try it

authenticate

Tools (16)