ShipStatic is an MCP server published by com.shipstatic, hosted at mcp.shipstatic.com. When last checked on 2026-11-22 it was working: it answers and lists its tools. It declares 15 tools, including deployments_upload, deployments_list, deployments_get, deployments_set, deployments_delete.
Deploy static websites, landing pages, and prototypes instantly. Free, no account needed.
1 connections through 5 shared values. Tap any node.
Deploy a static site to a live URL: free, no account or API key required. **File content is plain text by default.** Pass HTML/CSS/JS/JSON/SVG/etc. directly in each file's `content` as a regular string. Only set `encoding: "base64"` per-file for binary content (images, fonts) — do not base64-encode text. Returns the live URL. Without a connected account, the response also includes a one-time claim URL, and the site expires in 3 days unless claimed. Pass `password` to make the site private.
| Parameter | Type | Description |
|---|---|---|
| ttl | number | Seconds until this deployment expires and the platform reclaims it; omit for one that never does. Only for authenticated deploys — an anonymous deployment already expires on the platform's schedule, and a requested ttl on one is refused. A deployment carrying a ttl cannot be linked to any domain: de… |
| files * | array | Files that make up the site. The site root is implied by these paths. |
None yet. Changes appear after a server's second daily check.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
| labels | array | Labels for organizing deployments (e.g. ["env:production", "v1.2"]). Each is a word, or a key and a value split by one ":". Lowercase, 3-63 chars, allows . _ - inside a word. Up to 10. |
| password | string | Optional password to gate the deployment behind an unlock prompt (6–128 characters; whitespace significant). Visitors must enter this password before viewing the site, including on any custom domains pointing at it. |
| idempotencyKey | string | Makes this deploy replayable instead of repeatable. A deploy is not naturally idempotent: if a call times out you cannot tell "it never landed" from "it landed and the response was lost", and retrying creates a second deployment. Send the same key on the retry and you get back the deployment the fir… |
{
"name": "deployments_upload",
"title": "Deploy Static Site",
"description": "Deploy a static site to a live URL: free, no account or API key required.\n\n**File content is plain text by default.** Pass HTML/CSS/JS/JSON/SVG/etc. directly in each file's `content` as a regular string. Only set `encoding: \"base64\"` per-file for binary content (images, fonts) — do not base64-encode text.\n\nReturns the live URL. Without a connected account, the response also includes a one-time claim URL, and the site expires in 3 days unless claimed. Pass `password` to make the site private.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"files"
],
"properties": {
"ttl": {
"type": "number",
"description": "Seconds until this deployment expires and the platform reclaims it; omit for one that never does. Only for authenticated deploys — an anonymous deployment already expires on the platform's schedule, and a requested ttl on one is refused. A deployment carrying a ttl cannot be linked to any domain: deploy without one if the site needs a domain."
},
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"path",
"content"
],
"properties": {
"path": {
"type": "string",
"description": "Relative path within the site (e.g. \"index.html\", \"assets/app.css\"). No leading slash; no parent-folder wrapping."
},
"content": {
"type": "string",
"description": "File content as a plain text string. For HTML, CSS, JS, JSON, SVG, plain text — pass directly with no encoding step. For binary files (images, fonts) ONLY, set this entry's `encoding: \"base64\"` and pass base64-encoded bytes."
},
"encoding": {
"enum": [
"utf-8",
"base64"
],
"type": "string",
"description": "Defaults to `\"utf-8\"` (raw text). Set to `\"base64\"` ONLY for binary files. Never base64-encode text content — pass it as a plain string."
}
}
},
"description": "Files that make up the site. The site root is implied by these paths."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels for organizing deployments (e.g. [\"env:production\", \"v1.2\"]). Each is a word, or a key and a value split by one \":\". Lowercase, 3-63 chars, allows . _ - inside a word. Up to 10."
},
"password": {
"type": "string",
"description": "Optional password to gate the deployment behind an unlock prompt (6–128 characters; whitespace significant). Visitors must enter this password before viewing the site, including on any custom domains pointing at it."
},
"idempotencyKey": {
"type": "string",
"description": "Makes this deploy replayable instead of repeatable. A deploy is not naturally idempotent: if a call times out you cannot tell \"it never landed\" from \"it landed and the response was lost\", and retrying creates a second deployment. Send the same key on the retry and you get back the deployment the first try made, if it went live in the last 24 hours. A key works only within the account that sent it: without an account it is ignored, and a retry deploys again. Key the ATTEMPT (a run id, a commit sha, a uuid minted before the first try), never one minted fresh on each retry, which would defeat the point."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment",
"url",
"files",
"size",
"status",
"config",
"password",
"labels",
"via",
"created",
"expires",
"screenshot"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the live deployment."
},
"via": {
"type": [
"string",
"null"
],
"description": "How the deployment was created, as shown in deployment history (today one of: web, sdk, cli, mcp, git, n8n, gpt, vsc, cld, crs, gmn, api). Null on deployments older than the tag."
},
"size": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Total deployment size in bytes."
},
"claim": {
"type": "string",
"format": "uri",
"description": "One-time URL that claims this anonymous deployment to a free account, making it permanent. Only present on anonymous deploys; absent when the deploy was made with a connected account."
},
"files": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of files in the deployment."
},
"config": {
"type": "boolean",
"description": "True if the deployment includes a ship.json routing config."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the deployment; empty when none."
},
"status": {
"type": "string",
"description": "Deployment lifecycle state; \"success\" means the site is live. One of: pending, success, failed, deleting."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the deployment was created."
},
"expires": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when the deployment expires; null when permanent. Anonymous deployments expire 3 days after creation unless claimed; an authenticated deployment carries one only when it requested a ttl."
},
"password": {
"type": "boolean",
"description": "True if the deployment is password-protected."
},
"deployment": {
"type": "string",
"description": "Deployment hostname, e.g. \"happy-cat-abc1234.shipstatic.com\"."
},
"screenshot": {
"type": "string",
"format": "uri",
"description": "Full URL to the deployment screenshot. Rendered on the first request for it, so the URL is returned immediately and the first request takes a few seconds; every request after that is served immediately."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Deploy Static Site",
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}List all deployments with their URLs, status, labels, and password protection state. The response's `cursor` is null on the last page; pass it back as `cursor` to fetch the next.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum number of items to return in one page. Omit for the server default. |
| cursor | string | Opaque position from the previous response's `cursor` field; omit for the first page. |
{
"name": "deployments_list",
"title": "List Deployments",
"description": "List all deployments with their URLs, status, labels, and password protection state. The response's `cursor` is null on the last page; pass it back as `cursor` to fetch the next.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Maximum number of items to return in one page. Omit for the server default."
},
"cursor": {
"type": "string",
"description": "Opaque position from the previous response's `cursor` field; omit for the first page."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"cursor",
"deployments"
],
"properties": {
"cursor": {
"type": [
"string",
"null"
],
"description": "Opaque cursor for the next page; null on the last page. The whole has-more signal."
},
"deployments": {
"type": "array",
"items": {
"type": "object",
"required": [
"deployment",
"url",
"files",
"size",
"status",
"config",
"password",
"labels",
"via",
"created",
"expires",
"screenshot"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the live deployment."
},
"via": {
"type": [
"string",
"null"
],
"description": "How the deployment was created, as shown in deployment history (today one of: web, sdk, cli, mcp, git, n8n, gpt, vsc, cld, crs, gmn, api). Null on deployments older than the tag."
},
"size": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Total deployment size in bytes."
},
"files": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of files in the deployment."
},
"config": {
"type": "boolean",
"description": "True if the deployment includes a ship.json routing config."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the deployment; empty when none."
},
"status": {
"type": "string",
"description": "Deployment lifecycle state; \"success\" means the site is live. One of: pending, success, failed, deleting."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the deployment was created."
},
"expires": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when the deployment expires; null when permanent. Anonymous deployments expire 3 days after creation unless claimed; an authenticated deployment carries one only when it requested a ttl."
},
"password": {
"type": "boolean",
"description": "True if the deployment is password-protected."
},
"deployment": {
"type": "string",
"description": "Deployment hostname, e.g. \"happy-cat-abc1234.shipstatic.com\"."
},
"screenshot": {
"type": "string",
"format": "uri",
"description": "Full URL to the deployment screenshot. Rendered on the first request for it, so the URL is returned immediately and the first request takes a few seconds; every request after that is served immediately."
}
},
"additionalProperties": false
},
"description": "The deployments on this page."
}
},
"additionalProperties": false
},
"annotations": {
"title": "List Deployments",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Get deployment details including URL, status, file count, size, labels, and password protection state.
| Parameter | Type | Description |
|---|---|---|
| deployment * | string | Deployment hostname (e.g. "happy-cat-abc1234.shipstatic.com"). Returned by deployments_upload or deployments_list. |
{
"name": "deployments_get",
"title": "Get Deployment",
"description": "Get deployment details including URL, status, file count, size, labels, and password protection state.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment"
],
"properties": {
"deployment": {
"type": "string",
"description": "Deployment hostname (e.g. \"happy-cat-abc1234.shipstatic.com\"). Returned by deployments_upload or deployments_list."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment",
"url",
"files",
"size",
"status",
"config",
"password",
"labels",
"via",
"created",
"expires",
"screenshot"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the live deployment."
},
"via": {
"type": [
"string",
"null"
],
"description": "How the deployment was created, as shown in deployment history (today one of: web, sdk, cli, mcp, git, n8n, gpt, vsc, cld, crs, gmn, api). Null on deployments older than the tag."
},
"size": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Total deployment size in bytes."
},
"files": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of files in the deployment."
},
"config": {
"type": "boolean",
"description": "True if the deployment includes a ship.json routing config."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the deployment; empty when none."
},
"status": {
"type": "string",
"description": "Deployment lifecycle state; \"success\" means the site is live. One of: pending, success, failed, deleting."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the deployment was created."
},
"expires": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when the deployment expires; null when permanent. Anonymous deployments expire 3 days after creation unless claimed; an authenticated deployment carries one only when it requested a ttl."
},
"password": {
"type": "boolean",
"description": "True if the deployment is password-protected."
},
"deployment": {
"type": "string",
"description": "Deployment hostname, e.g. \"happy-cat-abc1234.shipstatic.com\"."
},
"screenshot": {
"type": "string",
"format": "uri",
"description": "Full URL to the deployment screenshot. Rendered on the first request for it, so the URL is returned immediately and the first request takes a few seconds; every request after that is served immediately."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Get Deployment",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Update deployment labels. Replaces all existing labels.
| Parameter | Type | Description |
|---|---|---|
| labels * | array | Labels to set. Replaces all existing labels. Pass empty array to clear. |
| deployment * | string | Deployment hostname (e.g. "happy-cat-abc1234.shipstatic.com"). Use deployments_list to find deployments. |
{
"name": "deployments_set",
"title": "Update Deployment Labels",
"description": "Update deployment labels. Replaces all existing labels.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment",
"labels"
],
"properties": {
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to set. Replaces all existing labels. Pass empty array to clear."
},
"deployment": {
"type": "string",
"description": "Deployment hostname (e.g. \"happy-cat-abc1234.shipstatic.com\"). Use deployments_list to find deployments."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment",
"url",
"files",
"size",
"status",
"config",
"password",
"labels",
"via",
"created",
"expires",
"screenshot"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the live deployment."
},
"via": {
"type": [
"string",
"null"
],
"description": "How the deployment was created, as shown in deployment history (today one of: web, sdk, cli, mcp, git, n8n, gpt, vsc, cld, crs, gmn, api). Null on deployments older than the tag."
},
"size": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Total deployment size in bytes."
},
"files": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Number of files in the deployment."
},
"config": {
"type": "boolean",
"description": "True if the deployment includes a ship.json routing config."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the deployment; empty when none."
},
"status": {
"type": "string",
"description": "Deployment lifecycle state; \"success\" means the site is live. One of: pending, success, failed, deleting."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the deployment was created."
},
"expires": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when the deployment expires; null when permanent. Anonymous deployments expire 3 days after creation unless claimed; an authenticated deployment carries one only when it requested a ttl."
},
"password": {
"type": "boolean",
"description": "True if the deployment is password-protected."
},
"deployment": {
"type": "string",
"description": "Deployment hostname, e.g. \"happy-cat-abc1234.shipstatic.com\"."
},
"screenshot": {
"type": "string",
"format": "uri",
"description": "Full URL to the deployment screenshot. Rendered on the first request for it, so the URL is returned immediately and the first request takes a few seconds; every request after that is served immediately."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Update Deployment Labels",
"readOnlyHint": false,
"openWorldHint": false,
"destructiveHint": true
}
}Permanently deletes a deployment and its files.
| Parameter | Type | Description |
|---|---|---|
| deployment * | string | Deployment hostname to delete (e.g. "happy-cat-abc1234.shipstatic.com") |
{
"name": "deployments_delete",
"title": "Delete Deployment",
"description": "Permanently deletes a deployment and its files.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment"
],
"properties": {
"deployment": {
"type": "string",
"description": "Deployment hostname to delete (e.g. \"happy-cat-abc1234.shipstatic.com\")"
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"deployment",
"status"
],
"properties": {
"status": {
"type": "string",
"description": "The state the deployment is in while background cleanup runs. One of: pending, success, failed, deleting."
},
"deployment": {
"type": "string",
"description": "The deployment hostname that was marked for removal."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Delete Deployment",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Create or update a domain: a ShipStatic domain (e.g. "yourname.shipstatic.com"), live as soon as a deployment is linked, or a custom domain (e.g. "www.example.com"), which needs DNS records first. Can reserve a name (omit deployment), link it to a deployment, switch deployments, or update labels. For a custom domain, domains_records then returns the DNS records to configure.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name: a ShipStatic domain (e.g. "yourname.shipstatic.com") or a custom domain (e.g. "www.example.com") |
| labels | array | Labels for organizing domains (e.g. ["production"]). |
| deployment | string | Deployment to serve on this domain (e.g. "happy-cat-abc1234.shipstatic.com"). Omit to reserve the domain without linking. |
{
"name": "domains_set",
"title": "Set Domain",
"description": "Create or update a domain: a ShipStatic domain (e.g. \"yourname.shipstatic.com\"), live as soon as a deployment is linked, or a custom domain (e.g. \"www.example.com\"), which needs DNS records first. Can reserve a name (omit deployment), link it to a deployment, switch deployments, or update labels. For a custom domain, domains_records then returns the DNS records to configure.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name: a ShipStatic domain (e.g. \"yourname.shipstatic.com\") or a custom domain (e.g. \"www.example.com\")"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels for organizing domains (e.g. [\"production\"])."
},
"deployment": {
"type": "string",
"description": "Deployment to serve on this domain (e.g. \"happy-cat-abc1234.shipstatic.com\"). Omit to reserve the domain without linking."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"url",
"status",
"deployment",
"linked",
"links",
"verification",
"verified",
"verifications",
"paused",
"labels",
"created",
"isCreate"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the domain."
},
"links": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many times a deployment has been linked to this domain."
},
"domain": {
"type": "string",
"description": "The domain name, e.g. \"www.example.com\"."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the domain; empty when none."
},
"linked": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when a deployment was last linked; null if never linked."
},
"paused": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when plan enforcement paused serving; null while the plan has room for it."
},
"status": {
"type": "string",
"description": "What this domain needs from its owner, derived: \"live\" serves the linked deployment and needs nothing; \"unlinked\" is verified with nothing published there, so link a deployment; \"unverified\" needs its DNS records configured; \"paused\" means the plan no longer has room for it. Read this word rather than recomputing it. One of: live, unlinked, unverified, paused."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the domain was created."
},
"isCreate": {
"type": "boolean",
"description": "True when this call created the domain; false when it updated an existing one."
},
"verified": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "When DNS last became verified; null if it never has, and never cleared, so a domain whose records moved away keeps it. Read `verification` for whether DNS is right now."
},
"deployment": {
"type": [
"string",
"null"
],
"description": "The deployment hostname this domain points to; null when reserved but not yet linked."
},
"verification": {
"type": "string",
"description": "How far DNS verification has got: \"pending\" is the site's CNAME not pointing here, \"partial\" is a www domain's CNAME pointing here without its apex A record (the redirect), \"verified\" is every required record. The diagnostic under \"unverified\"; ShipStatic domains are born verified. One of: pending, partial, verified."
},
"verifications": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many DNS verification attempts this domain has had."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Set Domain",
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": true
}
}List all domains with their URLs, linked deployment, and `status`. The response's `cursor` is null on the last page; pass it back as `cursor` to fetch the next.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum number of items to return in one page. Omit for the server default. |
| cursor | string | Opaque position from the previous response's `cursor` field; omit for the first page. |
{
"name": "domains_list",
"title": "List Domains",
"description": "List all domains with their URLs, linked deployment, and `status`. The response's `cursor` is null on the last page; pass it back as `cursor` to fetch the next.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Maximum number of items to return in one page. Omit for the server default."
},
"cursor": {
"type": "string",
"description": "Opaque position from the previous response's `cursor` field; omit for the first page."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"cursor",
"domains"
],
"properties": {
"cursor": {
"type": [
"string",
"null"
],
"description": "Opaque cursor for the next page; null on the last page. The whole has-more signal."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"domain",
"url",
"status",
"deployment",
"linked",
"links",
"verification",
"verified",
"verifications",
"paused",
"labels",
"created"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the domain."
},
"links": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many times a deployment has been linked to this domain."
},
"domain": {
"type": "string",
"description": "The domain name, e.g. \"www.example.com\"."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the domain; empty when none."
},
"linked": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when a deployment was last linked; null if never linked."
},
"paused": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when plan enforcement paused serving; null while the plan has room for it."
},
"status": {
"type": "string",
"description": "What this domain needs from its owner, derived: \"live\" serves the linked deployment and needs nothing; \"unlinked\" is verified with nothing published there, so link a deployment; \"unverified\" needs its DNS records configured; \"paused\" means the plan no longer has room for it. Read this word rather than recomputing it. One of: live, unlinked, unverified, paused."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the domain was created."
},
"verified": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "When DNS last became verified; null if it never has, and never cleared, so a domain whose records moved away keeps it. Read `verification` for whether DNS is right now."
},
"deployment": {
"type": [
"string",
"null"
],
"description": "The deployment hostname this domain points to; null when reserved but not yet linked."
},
"verification": {
"type": "string",
"description": "How far DNS verification has got: \"pending\" is the site's CNAME not pointing here, \"partial\" is a www domain's CNAME pointing here without its apex A record (the redirect), \"verified\" is every required record. The diagnostic under \"unverified\"; ShipStatic domains are born verified. One of: pending, partial, verified."
},
"verifications": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many DNS verification attempts this domain has had."
}
},
"additionalProperties": false
},
"description": "The domains on this page."
}
},
"additionalProperties": false
},
"annotations": {
"title": "List Domains",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Get domain details including URL, linked deployment, labels, and `status`: the one word saying what the domain needs from its owner (`unverified`, `unlinked`, `live`, `paused`).
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name (e.g. "www.example.com"). Use domains_list to find names. |
{
"name": "domains_get",
"title": "Get Domain",
"description": "Get domain details including URL, linked deployment, labels, and `status`: the one word saying what the domain needs from its owner (`unverified`, `unlinked`, `live`, `paused`).",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name (e.g. \"www.example.com\"). Use domains_list to find names."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"url",
"status",
"deployment",
"linked",
"links",
"verification",
"verified",
"verifications",
"paused",
"labels",
"created"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Full URL to the domain."
},
"links": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many times a deployment has been linked to this domain."
},
"domain": {
"type": "string",
"description": "The domain name, e.g. \"www.example.com\"."
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels attached to the domain; empty when none."
},
"linked": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when a deployment was last linked; null if never linked."
},
"paused": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "Unix timestamp (seconds) when plan enforcement paused serving; null while the plan has room for it."
},
"status": {
"type": "string",
"description": "What this domain needs from its owner, derived: \"live\" serves the linked deployment and needs nothing; \"unlinked\" is verified with nothing published there, so link a deployment; \"unverified\" needs its DNS records configured; \"paused\" means the plan no longer has room for it. Read this word rather than recomputing it. One of: live, unlinked, unverified, paused."
},
"created": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Unix timestamp (seconds) when the domain was created."
},
"verified": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "null"
}
],
"description": "When DNS last became verified; null if it never has, and never cleared, so a domain whose records moved away keeps it. Read `verification` for whether DNS is right now."
},
"deployment": {
"type": [
"string",
"null"
],
"description": "The deployment hostname this domain points to; null when reserved but not yet linked."
},
"verification": {
"type": "string",
"description": "How far DNS verification has got: \"pending\" is the site's CNAME not pointing here, \"partial\" is a www domain's CNAME pointing here without its apex A record (the redirect), \"verified\" is every required record. The diagnostic under \"unverified\"; ShipStatic domains are born verified. One of: pending, partial, verified."
},
"verifications": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "How many DNS verification attempts this domain has had."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Get Domain",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Returns the DNS records to configure at the domain's DNS provider. Call after domains_set. Custom domains only: a ShipStatic domain has no records to configure.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name. Must be a domain previously created with domains_set. |
{
"name": "domains_records",
"title": "Get DNS Records",
"description": "Returns the DNS records to configure at the domain's DNS provider. Call after domains_set. Custom domains only: a ShipStatic domain has no records to configure.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name. Must be a domain previously created with domains_set."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"apex",
"records"
],
"properties": {
"apex": {
"type": "string",
"description": "The apex (registered) domain where DNS records are managed."
},
"domain": {
"type": "string",
"description": "The domain the records are for."
},
"records": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "The DNS name to configure."
},
"type": {
"enum": [
"A",
"CNAME"
],
"type": "string",
"description": "Record type: A for the apex redirect, CNAME for the hosted subdomain."
},
"value": {
"type": "string",
"description": "The value to set: an IP for A, a hostname for CNAME."
}
},
"additionalProperties": false
},
"description": "The records to configure at the DNS provider, in the order to add them."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Get DNS Records",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Returns the DNS provider recorded for the domain, if known (e.g. Cloudflare, Namecheap): where its DNS records are configured. Custom domains only, and only while the domain is unverified; once its DNS is right there is nothing left to locate.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name (e.g. "www.example.com"). Must be a domain previously created with domains_set. |
{
"name": "domains_dns",
"title": "Get DNS Provider",
"description": "Returns the DNS provider recorded for the domain, if known (e.g. Cloudflare, Namecheap): where its DNS records are configured. Custom domains only, and only while the domain is unverified; once its DNS is right there is nothing left to locate.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name (e.g. \"www.example.com\"). Must be a domain previously created with domains_set."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"dns"
],
"properties": {
"dns": {
"anyOf": [
{
"type": "object",
"properties": {
"provider": {
"type": "object",
"required": [
"name"
],
"properties": {
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
],
"description": "The provider's DNS dashboard, where the records get added; null or absent when unknown."
},
"name": {
"type": [
"string",
"null"
],
"description": "Provider name, e.g. \"Cloudflare\"; null if unknown."
}
},
"description": "The provider serving this domain's DNS; absent when unidentified.",
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
],
"description": "What the platform recorded about the domain's DNS provider when the domain was created; null if nothing was recorded."
},
"domain": {
"type": "string",
"description": "The domain name."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Get DNS Provider",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Returns a shareable DNS setup URL that needs no API key, for whoever manages the domain's DNS. Custom domains only, and only while the domain is unverified; a verified domain has no setup left to share.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name to generate a share link for. Must be a domain previously created with domains_set. |
{
"name": "domains_share",
"title": "Share DNS Setup",
"description": "Returns a shareable DNS setup URL that needs no API key, for whoever manages the domain's DNS. Custom domains only, and only while the domain is unverified; a verified domain has no setup left to share.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name to generate a share link for. Must be a domain previously created with domains_set."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The shareable DNS setup URL; whoever opens it sees the records to configure, with no API key."
},
"domain": {
"type": "string",
"description": "The domain the setup link is for."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Share DNS Setup",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Check if a domain name is valid and available before creating it. Returns the normalized form and availability.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name to check (e.g. "yourname.shipstatic.com" or "www.example.com"). Call before domains_set to check availability. |
{
"name": "domains_validate",
"title": "Check Domain Availability",
"description": "Check if a domain name is valid and available before creating it. Returns the normalized form and availability.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name to check (e.g. \"yourname.shipstatic.com\" or \"www.example.com\"). Call before domains_set to check availability."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"valid",
"normalized",
"available",
"reason"
],
"properties": {
"valid": {
"type": "boolean",
"description": "Whether the domain's shape is usable."
},
"reason": {
"type": [
"string",
"null"
],
"description": "Why the name is unusable, for display; null when it is usable."
},
"available": {
"type": [
"boolean",
"null"
],
"description": "Whether nobody has registered the name yet; null when invalid. Creating it would be new; re-pointing your own domain is a write, not a create."
},
"normalized": {
"type": [
"string",
"null"
],
"description": "The normalized domain name; null when invalid."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Check Domain Availability",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}Trigger DNS verification for a custom domain. Call after the user has configured DNS records from domains_records. Custom domains only, and refused once the domain is verified: read domains_get instead. Verification is asynchronous: read the domain again with domains_get to learn the verdict, since its `status` has not moved yet when this returns. A verified domain serves nothing until a deployment is linked with domains_set.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name to verify DNS for. Must be a domain previously created with domains_set. |
{
"name": "domains_verify",
"title": "Verify Domain DNS",
"description": "Trigger DNS verification for a custom domain. Call after the user has configured DNS records from domains_records. Custom domains only, and refused once the domain is verified: read domains_get instead. Verification is asynchronous: read the domain again with domains_get to learn the verdict, since its `status` has not moved yet when this returns. A verified domain serves nothing until a deployment is linked with domains_set.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name to verify DNS for. Must be a domain previously created with domains_set."
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain whose DNS verification was queued, normalized. The check runs asynchronously; the domain's `verification` and `status` update once DNS propagates, so read the domain again rather than trusting this acknowledgement for a verdict."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Verify Domain DNS",
"readOnlyHint": false,
"openWorldHint": true,
"destructiveHint": false
}
}Permanently deletes a domain.
| Parameter | Type | Description |
|---|---|---|
| domain * | string | Domain name to delete (e.g. "www.example.com") |
{
"name": "domains_delete",
"title": "Delete Domain",
"description": "Permanently deletes a domain.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Domain name to delete (e.g. \"www.example.com\")"
}
}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "The domain name that was removed, normalized."
}
},
"additionalProperties": false
},
"annotations": {
"title": "Delete Domain",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Returns your email and name, and the account's plan, usage and caps.
No parameters.
{
"name": "whoami",
"title": "Show Account",
"description": "Returns your email and name, and the account's plan, usage and caps.",
"inputSchema": {
"type": "object",
"properties": {}
},
"outputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"name",
"plan",
"usage",
"caps"
],
"properties": {
"caps": {
"type": "object",
"required": [
"deployments",
"platformDomains",
"customDomains",
"members"
],
"properties": {
"members": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Member places: as caps, how many people the plan allows, the owner included; as usage, the members the account has."
},
"deployments": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Deployments, every row whatever its status."
},
"customDomains": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Hostnames the customer owns, paused ones included."
},
"platformDomains": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "ShipStatic domains, like \"my-app.shipstatic.com\", paused ones included."
}
},
"description": "What the account is allowed to hold, under usage's cap keys, so the pair divides. A pending invitation takes a member place, so it counts against members.",
"additionalProperties": false
},
"name": {
"type": [
"string",
"null"
],
"description": "Display name; null if not set."
},
"plan": {
"type": "string",
"description": "The plan the account is on. One of: free, pro, team, scale, sponsored."
},
"email": {
"type": "string",
"description": "The account email address."
},
"usage": {
"type": "object",
"required": [
"deployments",
"platformDomains",
"customDomains",
"members",
"invitations"
],
"properties": {
"members": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Member places: as caps, how many people the plan allows, the owner included; as usage, the members the account has."
},
"deployments": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Deployments, every row whatever its status."
},
"invitations": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Invitations still open: pending and not yet expired. Each takes a member place beside the members, against the members cap."
},
"customDomains": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Hostnames the customer owns, paused ones included."
},
"platformDomains": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "ShipStatic domains, like \"my-app.shipstatic.com\", paused ones included."
}
},
"description": "What the account currently holds: every cap, and the pending invitations beside them.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"title": "Show Account",
"readOnlyHint": true,
"openWorldHint": false,
"destructiveHint": false
}
}ShipStatic deploys static websites instantly. Free, no account needed. Deploy straight away, and bring up an account only when the user asks to see or manage their sites, or to use their own domain. To deploy: call deployments_upload with the files to publish. If you can run commands and the site is a folder on disk, publish it with the ShipStatic CLI instead: it reads the files from disk. The files need an `index.html` at the top: it's the page visitors see first, and a site without one is refused. To publish one page, name it `index.html`. To publish another kind of file, like a PDF, add a small `index.html` that links to it. The site is live immediately. To make the site private, pass `password`: that is ShipStatic's built-in password protection, checked before any file is served. When the user asks for a password or a private site, use it, and do not build a password page or script into the site itself. Visitors must unlock before viewing, including on any custom domains pointing at it. Tell the user any password you set, since one they never see locks them out. Without a connected account, deployments are public and expire in 3 days. The response includes a claim URL — always show the deployment URL and the claim URL to the user so they can keep the site permanently. Connected to an account, deployments go to that account and never expire — pass `ttl` (seconds) to deployments_upload for one that expires on its own. Listing, managing, and domain operations need a connected account — call one and the client is told how to connect. Concepts: - Deployment: an immutable set of files with an instant URL (e.g. happy-cat-abc1234.shipstatic.com). No setup needed. - Domain: a name pointing to a deployment. Optional. A ShipStatic domain (e.g. yourname.shipstatic.com) needs no setup; a custom domain (e.g. www.example.com) needs DNS records. Subdomains only, not apex domains. To give a deployment a ShipStatic domain: domains_validate → domains_set with the domain and the deployment. It is live at once, with no DNS. To add a custom domain: domains_validate → domains_set → domains_records (show DNS records to user) → user configures DNS → domains_verify, only while its `status` is `unverified` → domains_set with the deployment to serve. A domain serves nothing until a deployment is linked, so ask the user which one and link it. Read `status` to know where a domain stands: `unverified` means its DNS records are not configured yet, `unlinked` means DNS is right and nothing is published there, `live` means it serves, `paused` means the plan has no room for it.
Names, descriptions and schemas were written by the server and are shown as data.