ShipDapp

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.

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

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.

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

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).

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

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).

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

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.

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

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.

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

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.

{
  "type": "object",
  "properties": {
    "appName": {
      "type": "string",
      "description": "Application name — becomes part of the Artifact Registry image tag"
    },
    "templateId": {
      "type": "string",
      "description": "From list_templates (e.g. webapp-static). Required — provides build defaults."
    },
    "files": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      },
      "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."
    },
    "buildCommand": {
      "description": "Override template default (webapp-static: npm run build)",
      "type": "string"
    },
    "startCommand": {
      "description": "Override template default (webapp-static production: npm start → serve -s dist)",
      "type": "string"
    },
    "dockerfileContent": {
      "description": "Only if you need a custom Dockerfile instead of buildpacks",
      "type": "string"
    },
    "mergeMode": {
      "default": "strict",
      "description": "strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).",
      "type": "string",
      "enum": [
        "strict",
        "scaffold"
      ]
    }
  },
  "required": [
    "appName",
    "templateId",
    "files"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

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.

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

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.

{
  "type": "object",
  "properties": {
    "appName": {
      "type": "string",
      "description": "Unique app name used for the image tag and My Apps"
    },
    "templateId": {
      "type": "string",
      "description": "From list_templates (e.g. webapp-static). Must match how the app was scaffolded."
    },
    "files": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      },
      "description": "Complete local project files including all required paths (list_template_files). Omit package-lock.json. Must pass local npm run build first."
    },
    "description": {
      "description": "Short description shown on the app listing when listed",
      "type": "string"
    },
    "port": {
      "description": "Container listen port (webapp-static default: 3000)",
      "type": "number"
    },
    "imageUrl": {
      "description": "Preview/thumbnail URL for the app card in the store",
      "type": "string"
    },
    "buildCommand": {
      "description": "Override template build command if needed",
      "type": "string"
    },
    "startCommand": {
      "description": "Override production start (webapp-static default: npm start → serve -s dist). Do not use vite preview for production.",
      "type": "string"
    },
    "dockerfileContent": {
      "description": "Custom Dockerfile — omit to use Google Cloud Buildpacks",
      "type": "string"
    },
    "mergeMode": {
      "default": "strict",
      "description": "strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).",
      "type": "string",
      "enum": [
        "strict",
        "scaffold"
      ]
    },
    "listOnStore": {
      "description": "If true, list this app on the public App Store. Default false (unlisted; proxyUri still works).",
      "type": "boolean"
    }
  },
  "required": [
    "appName",
    "templateId",
    "files"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

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.

{
  "type": "object",
  "properties": {
    "appName": {
      "type": "string",
      "description": "Unique app name shown in My Apps"
    },
    "dockerImage": {
      "type": "string",
      "description": "Public container image URI, e.g. ghcr.io/acme/my-app:latest or docker.io/library/nginx:alpine"
    },
    "description": {
      "description": "Short description shown on the app listing when listed",
      "type": "string"
    },
    "port": {
      "description": "Container listen port (default: 3000)",
      "type": "number"
    },
    "imageUrl": {
      "description": "Preview/thumbnail URL for the app card in the store",
      "type": "string"
    },
    "startCommand": {
      "description": "Optional command override if the image needs one",
      "type": "string"
    },
    "listOnStore": {
      "description": "If true, list this app on the public App Store. Default false (unlisted; proxyUri still works).",
      "type": "boolean"
    }
  },
  "required": [
    "appName",
    "dockerImage"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

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.

{
  "type": "object",
  "properties": {
    "deploymentId": {
      "type": "string",
      "description": "Existing deployment ID from deploy_app or list_apps"
    },
    "files": {
      "description": "New local files — triggers a cloud rebuild before redeploying",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "templateId": {
      "description": "Required when files is provided — same template used originally",
      "type": "string"
    },
    "appName": {
      "description": "Rename the app (optional)",
      "type": "string"
    },
    "description": {
      "description": "Update the app description (optional)",
      "type": "string"
    },
    "port": {
      "description": "Change container port (optional)",
      "type": "number"
    },
    "dockerImage": {
      "description": "Pre-built image URI — use instead of files when image is already built",
      "type": "string"
    },
    "buildCommand": {
      "type": "string"
    },
    "startCommand": {
      "type": "string"
    },
    "mergeMode": {
      "default": "strict",
      "description": "strict (default): reject missing required files and placeholder garbage. scaffold: fill omitted scaffold files from template defaults (emits warnings).",
      "type": "string",
      "enum": [
        "strict",
        "scaffold"
      ]
    }
  },
  "required": [
    "deploymentId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

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.

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

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.

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

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.

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

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.

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

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.

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