Servers Playground How we check Add a server Log in

SHIP

Working · 1.8 s

ai.letsship/shipv0.24.0 Domain verified

Assign Linear, Jira or GitHub issues to an AI coding agent team that plans, builds, reviews, tests.

Developer Tools

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.letsship.ai/mcp

Authorization (optional)

A SHIP personal access token, sent as a bearer token. Create one at https://letsship.ai/settings/tokens. Leave it out to sign in with OAuth instead.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

activate_sandbox_template_version

Make a version the one missions use from their next dispatch. It is rebuilt only if its snapshot is gone; the response says which.

versionIdstring, required

Version id (stv_...)

templateIdstring, required

Sandbox id (sbt_...)

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

SHIP MCP server | mcptry

SHIP

Working · 1.8 s

ai.letsship/shipv0.24.0 Domain verified

Assign Linear, Jira or GitHub issues to an AI coding agent team that plans, builds, reviews, tests.

Developer Tools

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://mcp.letsship.ai/mcp

Authorization (optional)

A SHIP personal access token, sent as a bearer token. Create one at https://letsship.ai/settings/tokens. Leave it out to sign in with OAuth instead.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

activate_sandbox_template_version

Make a version the one missions use from their next dispatch. It is rebuilt only if its snapshot is gone; the response says which.

versionIdstring, required

Version id (stv_...)

templateIdstring, required

Sandbox id (sbt_...)

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (72)

activate_sandbox_template_version

Make a version the one missions use from their next dispatch. It is rebuilt only if its snapshot is gone; the response says which.

Argument	Type	Description
versionId*	string	Version id (stv_...)
templateId*	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "templateId",
    "versionId"
  ],
  "properties": {
    "versionId": {
      "type": "string",
      "description": "Version id (stv_...)"
    },
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

approve_mission_ceiling

A mission that reached its credit limit pauses until a member lets it continue. This raises the mission's limit by one step and runs the stage that stopped again, so it spends credits: ask the person first. Returns the new limit. Answers 409 when the mission is not at its limit. Requires the missions:run scope.

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412
projectId*	string	Project id the mission belongs to (get_mission's summary.projectId)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "projectId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to (get_mission's summary.projectId)"
    }
  }
}

archive_mission

Hide a finished mission from list_missions and the board. Nothing else changes: unarchive_mission shows it again. Requires the missions:write scope and the config:write capability (an owner or admin).

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

bind_mcp_server

Create or update the binding for a server the repository declares. roles is the full set of pipeline roles that may use it (reviewer and qa only ever receive read-only tools, and cannot use a server that runs inside the sandbox). transport: 'remote' (the gateway proxies to the server's URL), 'isolate' (the gateway runs the server's npm package in isolation, for a command that needs a secret) or 'local' (the command runs inside the sandbox, no credential). Omit transport and remoteUrl on an update to keep the server the binding is pinned to, with its credential (a roles, tools or credential edit); set them only to bind or re-point the server. Requires the config:write capability.

destructive

Argument	Type	Description
roles*	array	Every role that may use the server ([] disables it)
projectId*	string	Project id, e.g. from list_projects
remoteUrl	string	A fixed https URL: a hosted endpoint for a command server, or an override for a URL server
transport	string	How the gateway reaches the server: 'remote' proxies to remoteUrl, 'isolate' runs the server's npm package away from the sandbox so a secret stays out of it, and 'local' runs the command inside the sandbox with no credential. Omit it on an update to keep the server the binding is pinned to.
credential	any	Write-only credential the gateway attaches; agents never receive it. Omit to keep the stored one. OAuth credentials are not set here: bind as remote with kind 'none', then start_mcp_server_oauth.

build_sandbox_template

Build the sandbox's active version, or return the build already running for it.

Argument	Type	Description
templateId*	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "templateId"
  ],
  "properties": {
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

clear_agents_override

Delete the per-issue agents/baseBranch override — the mission resolves from ship.yml again.

destructive

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-353 or WEB-42
projectId*	string	Project id the mission belongs to

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "projectId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-353 or WEB-42"
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to"
    }
  }
}

create_mission

Create the tracker issue AND start the run in one call, for work that has no issue yet. Pass entryStartAt='builder' with an entryPlan to hand over a plan you already wrote; pass entryStartAt='reviewer'/'qa' with entryPrNumber to hand over an existing build — in which case title may be omitted and the pull request's own title names the mission. This tool calls the SHIP API, documented at https://letsship.ai/docs/api. Requires the missions:run token scope.

Argument	Type	Description
title	string	Issue title. Omit ONLY with entryPrNumber — the pull request's own title is then used
agents	object	Per-role harness/model override for THIS mission only; overrides ship.yml without changing it
labels	array	Tracker labels to apply
entryPlan	string	Hand-off plan markdown, for entryStartAt='builder'
projectId*	string	Project id the mission belongs to
description	string	Issue body; acceptance criteria written here are parsed as they would be on any issue
entryStartAt	string	Pipeline stage to enter at; omit for the default full run starting at the planner
entryPrNumber

create_scheduled_task

Create a recurring agent mission. Firing it — on schedule, or immediately via run_scheduled_task — creates an ordinary tracker issue assigned to the agent, which drives a normal pipeline run: a scheduled task is a stored mission request, not a new execution mode. This tool calls the SHIP API, documented at https://letsship.ai/docs/api. Requires the config:write capability.

Argument	Type	Description
name*	string	Scheduled task name, shown in the console and used in the issue title
time*	string	24-hour wall-clock time in `timezone`, e.g. '09:00'.
labels	array	Tracker label names put on every issue this scheduled task files (default none). The label must ALREADY exist in the project's tracker team — the platform attaches labels but cannot create them, so a name the workspace does not have is dropped.
prompt*	string	Becomes the created issue's description verbatim on every fire
enabled	boolean	Whether the schedule is armed (default true)
weekday	string	Day of week — required when interval is 'weekly'.
interval*	string	Fire cadence. 'weekly' requires weekday; 'monthly' requires dayOfMonth.

decline_mission

Close the mission's open pull request on GitHub without merging it; the mission becomes declined, and no call here reopens it. Requires the missions:write scope.

destructive

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

delete_sandbox_registry

Delete the stored credential of a private registry (an id from list_sandbox_registries). A sandbox build that installs from that host then gets no credential. Requires the connectors:write scope and the config:write capability.

destructive

Argument	Type	Description
registryId*	string	Registry credential id, from list_sandbox_registries

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "registryId"
  ],
  "properties": {
    "registryId": {
      "type": "string",
      "description": "Registry credential id, from list_sandbox_registries"
    }
  }
}

delete_sandbox_template

Delete a sandbox with all its versions and builds. Answers 409 while an agent or a project's default sandbox uses it: point those at another sandbox first (update_project with defaultSandboxTemplateId). Missions that run in it now finish. Requires the agents:write scope and the config:write capability.

destructive

Argument	Type	Description
templateId*	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "templateId"
  ],
  "properties": {
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

delete_scheduled_task

Delete a scheduled task and its run history, which no call can bring back. Missions it already started continue. Setting enabled to false stops new runs and keeps the task and its history. Requires the scheduled-tasks:write scope and the config:write capability.

destructive

Argument	Type	Description
scheduledTaskId*	string	Scheduled task id to delete

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "scheduledTaskId"
  ],
  "properties": {
    "scheduledTaskId": {
      "type": "string",
      "description": "Scheduled task id to delete"
    }
  }
}

destroy_environment

Request teardown of a preview environment (its deployed Worker(s) + every provisioned datastore). Enqueues to the orchestrator; requires project write capability.

destructive

Argument	Type	Description
environmentId*	string	Environment id to tear down

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "environmentId"
  ],
  "properties": {
    "environmentId": {
      "type": "string",
      "description": "Environment id to tear down"
    }
  }
}

dismiss_notice

Close a notice for the person this token acts for, as the console's close button does. Only a notice with dismissible: true can be closed (a low balance). It stays closed while its id lasts: a low balance that a top-up ends and a later spend brings back has a new id and shows again. Critical notices cannot be closed.

Argument	Type	Description
noticeId*	string	The notice's id from get_notices, e.g. credits_low:<grant>

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "noticeId"
  ],
  "properties": {
    "noticeId": {
      "type": "string",
      "description": "The notice's id from get_notices, e.g. credits_low:<grant>"
    }
  }
}

get_agent_run

Fetch one agent run: its run record, metric series (CPU/mem/disk over time), and the agent session summaries (role, outcome, cost, sessionId). sessions lists every session of the run's role on the mission; runSessionId names this run's own, so read its log and cost from that one.

read-only

Argument	Type	Description
sandboxId*	string	Agent run id: the run's sandbox id, from list_agent_runs

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sandboxId"
  ],
  "properties": {
    "sandboxId": {
      "type": "string",
      "description": "Agent run id: the run's sandbox id, from list_agent_runs"
    }
  }
}

get_agent_run_logs

Fetch a session's log content from one agent run. part=session is the agent stream-json (reasoning + tool calls); part=system is the container/runner stdout (clone, dependency install, validation gate, git, callback); part=prompt is the assembled input prompt. The role and sessionId are fields of the agent run's own record. A log longer than 40,000 characters returns its end, from a whole line, with a note.

read-only

Argument	Type	Description
part	string	Which log stream to read
role*	string	Agent role: planner \| builder \| reviewer \| qa
sandboxId*	string	Agent run id: the run's sandbox id
sessionId*	string	Session id from get_agent_run's sessions list

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sandboxId",
    "role",
    "sessionId"
  ],
  "properties": {
    "part": {
      "enum": [
        "session",
        "system",
        "prompt"
      ],
      "type": "string",
      "default": "session",
      "description": "Which log stream to read"
    },
    "role": {
      "type": "string",
      "description": "Agent role: planner | builder | reviewer | qa"
    },
    "sandboxId": {
      "type": "string",
      "description": "Agent run id: the run's sandbox id"
    },
    "sessionId": {
      "type": "string",
      "description": "Session id from get_agent_run's sessions list"
    }
  }
}

get_agents_override

Read the per-issue agents/baseBranch override record for one mission, or null when unset.

read-only

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-353 or WEB-42
projectId*	string	Project id the mission belongs to

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "projectId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-353 or WEB-42"
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to"
    }
  }
}

get_artifact

Fetch one artifact's metadata + a long-lived signed serving url (open it to view the screenshot/video).

read-only

Argument	Type	Description
id*	string	Artifact id (from list_artifacts)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Artifact id (from list_artifacts)"
    }
  }
}

get_billing

Read the workspace's credit balance by source and expiry, whether a new mission would start now, the per-mission credit ceiling, the project allowance and recent usage. Check it before dispatching work.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

get_environment

Fetch one preview environment's registry row (status, worker name, timestamps).

read-only

Argument	Type	Description
environmentId*	string	Environment id (from list_environments)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "environmentId"
  ],
  "properties": {
    "environmentId": {
      "type": "string",
      "description": "Environment id (from list_environments)"
    }
  }
}

get_mission

Fetch one mission. view='summary' (the default, small enough to poll) returns its summary (activity, stage, review/check/test state, PR, paused and pauseSource, cost), its agent runs (sandboxId, role, status, harness, model, cost) and proofRunSandboxId (pass it to list_artifacts as sandboxId for the proof). view='full' adds its stages, events, stats and the plan/review/QA outcomes. pauseSource 'checkpoint:<role>' means a checkpoint holds it: resume_mission approves that stage. Requires the missions:read scope.

read-only

Argument	Type	Description
view	string	summary (default) for the state, runs and proof run; full for every stage, event and outcome
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412
orgSlug	string	Narrow an issue id to one org
projectId	string	Narrow an issue id that two projects share

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "view": {
      "enum": [
        "summary",
        "full"
      ],
      "type": "string",
      "default": "summary",
      "description": "summary (default) for the state, runs and proof run; full for every stage, event and outcome"
    },
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    },
    "orgSlug": {
      "type": "string",
      "description": "Narrow an issue id to one org"
    },
    "projectId": {
      "type": "string",
      "description": "Narrow an issue id that two projects share"
    }
  }
}

get_notices

Read what needs attention in the workspace, critical first: a tracker connection its vendor no longer accepts (missions cannot start or report back until someone reconnects it), or credits running out. Each notice has a stable id and kind, a message and, when the caller can act, an action URL to hand to a person. A notice the caller dismissed is left out. Check it before dispatching work.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

get_project

Fetch a single project by its UUID. Returns 404 if the project is not in the caller's org.

read-only

Argument	Type	Description
projectId*	string	Project UUID

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId"
  ],
  "properties": {
    "projectId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Project UUID"
    }
  }
}

get_sandbox_build_log

A page of a build's log after sequence number `after`. Call again with after = nextAfter until done is true.

read-only

Argument	Type	Description
after	integer	Return chunks after this sequence number (default 0)
buildId*	string	Build id (tbd_...)
templateId*	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "templateId",
    "buildId"
  ],
  "properties": {
    "after": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Return chunks after this sequence number (default 0)"
    },
    "buildId": {
      "type": "string",
      "description": "Build id (tbd_...)"
    },
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

get_sandbox_capacity

How many agents the org's missions are running at once against its limit (null while the org is unclassified), which missions wait for an agent slot and why, and whether every slot on the platform is taken. Read from the platform's once-a-minute capacity check.

read-only

Argument	Type	Description
orgId	string	Required only for a caller in several orgs

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "orgId": {
      "type": "string",
      "description": "Required only for a caller in several orgs"
    }
  }
}

get_scheduled_task

Fetch one scheduled task by id: its project, name, prompt, triggers (schedule), labels, template key, skip-if-previous-open setting, enabled state, and next/last run times. An id outside the caller's accessible projects returns not found. For what each fire produced, use list_scheduled_task_runs.

read-only

Argument	Type	Description
scheduledTaskId*	string	Scheduled task id, e.g. from list_scheduled_tasks

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "scheduledTaskId"
  ],
  "properties": {
    "scheduledTaskId": {
      "type": "string",
      "description": "Scheduled task id, e.g. from list_scheduled_tasks"
    }
  }
}

get_setup_progress

Read what the workspace has set up with SHIP so far, as the console's setup checklist shows it: up to 13 milestones in three groups, taken in order (get started, make it yours, make it autonomous). `activeGroup` names the group to work on now, and each group carries its own count. Each milestone says whether it is reached and, when a console page takes it and the caller's role can, the page that does it. `next` names the first milestone not reached yet. Use it to suggest the next step to a person.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

healthz

Returns the upstream API status, environment, and version.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

inspect_mission

Fetch the typed platform-inspection report for a mission, by its issue id. Returns per-section KV/D1/R2 state: task state, retry reason, dispatch error, latest review + QA verdicts, run index, per-attempt provenance, running sandboxes, and session-log heads. Requires the inspect:read scope.

read-only

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-199 or WEB-42
orgSlug	string	Narrow an ambiguous issue code to one org
sections	string	Comma-separated section filter (default all): taskState,retryReason,provenance,…
projectId	string	Scope to a specific project id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-199 or WEB-42"
    },
    "orgSlug": {
      "type": "string",
      "description": "Narrow an ambiguous issue code to one org"
    },
    "sections": {
      "type": "string",
      "description": "Comma-separated section filter (default all): taskState,retryReason,provenance,…"
    },
    "projectId": {
      "type": "string",
      "description": "Scope to a specific project id"
    }
  }
}

list_agent_runs

List the agent runs, live and finished, in the caller's accessible projects, newest first. Each run is one agent in its own sandbox. Returns id (the run's sandbox id), issueId, role, harness, status, instance type, and latest CPU/memory/disk metrics. When more runs match, nextCursor is set: pass it back as cursor, with the same filters, for the next page.

read-only

Argument	Type	Description
role	string	Only the runs of this agent role
limit	integer	Max results (default 50). Narrow with projectId, issueId, role or status before raising it.
cursor	string	nextCursor from the previous page; omit for the newest runs
status	string	Filter by how the run stands: running, completed (finished), stopped (ended on purpose before it finished), failed, or stale (closed without a report)
issueId	string	Only the runs of this mission, by its issue id, e.g. SHIP-412
projectId	string	Filter to one project id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "role": {
      "enum": [
        "planner",
        "builder",
        "reviewer",
        "qa"
      ],
      "type": "string",
      "description": "Only the runs of this agent role"
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 500,
      "minimum": 1,
      "description": "Max results (default 50). Narrow with projectId, issueId, role or status before raising it."
    },
    "cursor": {
      "type": "string",
      "description": "nextCursor from the previous page; omit for the newest runs"
    },
    "status": {
      "enum": [
        "running",
        "stale",
        "completed",
        "stopped",
        "failed"
      ],
      "type": "string",
      "description": "Filter by how the run stands: running, completed (finished), stopped (ended on purpose before it finished), failed, or stale (closed without a report)"
    },
    "issueId": {
      "type": "string",
      "description": "Only the runs of this mission, by its issue id, e.g. SHIP-412"
    },
    "projectId": {
      "type": "string",
      "description": "Filter to one project id"
    }
  }
}

list_artifacts

List proof-of-work artifacts (QA screenshots/video/traces) for the caller's accessible projects. Each row carries kind, content type, caption, the acceptance criterion it proves, the sandboxId of the agent run that produced it, and a long-lived signed serving url. Filter by issueId to get one ticket's evidence: the artifacts of every run, superseded QA attempts included, up to limit; a note says when more exist. For the mission's proof of work specifically, read proofRunSandboxId from GET /v1/missions/{id} and pass it as sandboxId.

read-only

Argument	Type	Description
limit	integer	Max results (default 50). Narrow with issueId or sandboxId before raising it.
issueId	string	Filter to one issue (e.g. SHIP-133)
projectId	string	Filter to one project id
sandboxId	string	Filter to ONE agent run's artifacts (e.g. the mission's proofRunSandboxId)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 2000,
      "minimum": 1,
      "description": "Max results (default 50). Narrow with issueId or sandboxId before raising it."
    },
    "issueId": {
      "type": "string",
      "description": "Filter to one issue (e.g. SHIP-133)"
    },
    "projectId": {
      "type": "string",
      "description": "Filter to one project id"
    },
    "sandboxId": {
      "type": "string",
      "description": "Filter to ONE agent run's artifacts (e.g. the mission's proofRunSandboxId)"
    }
  }
}

list_billing_ledger

List where the workspace's credits went, newest first: one entry per mission (its start, each further 3 agent-hours, and messages charged before messages became free), per grant, per adjustment and per expiry. Pass nextCursor back as cursor for the next page. Owners and admins only.

read-only

Argument	Type	Description
limit	integer	Entries per page, 1-100 (default 50).
cursor	string	nextCursor from the previous page; omit for the newest entries.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Entries per page, 1-100 (default 50)."
    },
    "cursor": {
      "type": "string",
      "description": "nextCursor from the previous page; omit for the newest entries."
    }
  }
}

list_credit_offers

List what SHIP sells: the credit packs (credits, the price in US dollars before tax, which checkout adds for the buyer's location, and the price per credit), the monthly plans under `team.plans` (Starter and Scale: each its credits a month, monthly price, price per credit, which credits added on top also cost, and agents at once), the range of credits a workspace on a plan can add at once, Enterprise under `enterprise` (the minimum yearly credit commitment, the highest and lowest price per credit, and the agents at once at the minimum; contracts are sold by SHIP, not through checkout), what Free and the packs allow (`limits`), plus the trial size. The same catalog the pricing page shows.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_environments

List per-mission preview environments for the caller's accessible projects. Returns id, issueId, projectId, prNumber, workerName, and lifecycle status.

read-only

Argument	Type	Description
limit	integer	Max results (default 50). Narrow with issueId, projectId or status before raising it.
status	string	Filter by lifecycle status
issueId	string	Filter to one issue id
projectId	string	Filter to one project id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 500,
      "minimum": 1,
      "description": "Max results (default 50). Narrow with issueId, projectId or status before raising it."
    },
    "status": {
      "enum": [
        "provisioning",
        "active",
        "destroying",
        "destroyed",
        "failed"
      ],
      "type": "string",
      "description": "Filter by lifecycle status"
    },
    "issueId": {
      "type": "string",
      "description": "Filter to one issue id"
    },
    "projectId": {
      "type": "string",
      "description": "Filter to one project id"
    }
  }
}

list_mcp_bindings

Every MCP server binding across the projects you can see in your org: project, server, transport, status, enabled roles, how it authenticates, and the NAMES of the credential fields set (never values). Use it to find where a credential is used; use list_mcp_servers for one project's full detail.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_mcp_servers

The MCP servers a project's repository declares in its MCP file (.mcp.json by default), each with its binding: enabled roles, transport, status, approved tools, per-role effective tool counts (null when the server runs inside the sandbox and the role gets every tool it exposes), and the NAMES of the credential fields set (never values). Also reports whether the file could be read (configStatus).

read-only

Argument	Type	Description
projectId*	string	Project id, e.g. from list_projects

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId"
  ],
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    }
  }
}

list_missions

List missions in the caller's accessible projects, newest activity first, with total for paging. Each has issueId, title, activity (what it does now), pipelineProgress, review/check/test state, PR, cost and paused. Archived missions are left out. Requires the missions:read scope.

read-only

Argument	Type	Description
limit	integer	Page size (default 25). Narrow with projectId, activity or search before raising it.
offset	integer	Rows to skip, for the next page
search	string	Match the issue id, title, owner or repository
activity	string	Filter by what the mission does now
projectId	string	Filter to one project id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 25,
      "maximum": 100,
      "minimum": 1,
      "description": "Page size (default 25). Narrow with projectId, activity or search before raising it."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Rows to skip, for the next page"
    },
    "search": {
      "type": "string",
      "description": "Match the issue id, title, owner or repository"
    },
    "activity": {
      "enum": [
        "queued",
        "planning",
        "building",
        "fixing_ci",
        "addressing_review",
        "addressing_qa",
        "ci_running",
        "ci_failed",
        "reviewing",
        "changes_requested",
        "deploying",
        "testing",
        "qa_failed",
        "ready_to_merge",
        "auto_merging",
        "needs_attention",
        "merged",
        "auto_merged",
        "declined",
        "pausing",
        "paused",
        "stopped"
      ],
      "type": "string",
      "description": "Filter by what the mission does now"
    },
    "projectId": {
      "type": "string",
      "description": "Filter to one project id"
    }
  }
}

list_orgs

List every organization on the platform with its owner email, member count, and pending invite status. Requires platform-admin (cross_org) access. Cursor-paginated (default page size 50) — feed the response's nextCursor back as the cursor input to reach the next page; a null nextCursor means there are no more pages.

read-only

Argument	Type	Description
limit	integer	Page size, 1-100 (API default 50)
cursor	string	Opaque page cursor, echoed back as nextCursor by a prior call

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1-100 (API default 50)"
    },
    "cursor": {
      "type": "string",
      "description": "Opaque page cursor, echoed back as nextCursor by a prior call"
    }
  }
}

list_projects

List the projects accessible to the calling principal. Returns id, slug, name, status, createdAt for each.

read-only

Argument	Type	Description
limit	integer	Max results (default 20)
cursor	string	Opaque pagination cursor from a previous call

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Max results (default 20)"
    },
    "cursor": {
      "type": "string",
      "description": "Opaque pagination cursor from a previous call"
    }
  }
}

list_sandbox_registries

The org's private package registries sandboxes install from: host, auth scheme, username. Never the secret.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_sandbox_starters

Ready-made sandbox definitions (Python, Java, Go, Rust, Ruby) to create a sandbox from.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_sandbox_template_versions

Every saved version of a sandbox, newest first, with the active one marked and each one's latest build.

read-only

Argument	Type	Description
templateId*	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "templateId"
  ],
  "properties": {
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

list_sandbox_templates

List the org's sandboxes (definitions agents start in), with each one's active version, size and latest build status.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_scheduled_task_runs

Run history for one scheduled task, each row's status (dispatching/dispatched/skipped/failed) and, once its issue exists, the joined mission progress/cost. A 'dispatched' status means the issue was created and the mission started — never that the work succeeded; read the joined mission state for that. Newest first; when older runs exist, pass nextCursor back as cursor for the next page.

read-only

Argument	Type	Description
limit	integer	Runs per page, 1-200 (default 50)
cursor	string	nextCursor from the previous page; omit for the newest runs
scheduledTaskId*	string	Scheduled task id

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "scheduledTaskId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "description": "Runs per page, 1-200 (default 50)"
    },
    "cursor": {
      "type": "string",
      "description": "nextCursor from the previous page; omit for the newest runs"
    },
    "scheduledTaskId": {
      "type": "string",
      "description": "Scheduled task id"
    }
  }
}

list_scheduled_task_templates

Read-only gallery of curated scheduled task templates — a prepared prompt plus a suggested cadence. A template is content, not a code path: pass its key as templateKey on create_scheduled_task for attribution, or copy its prompt/schedule into a hand-written scheduled task.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

list_scheduled_tasks

List recurring agent missions (scheduled tasks) across the caller's accessible projects — schedule, enabled state, and next/last fire time for each. Pass projectId for the tasks of one project.

read-only

Argument	Type	Description
projectId	string	Only the scheduled tasks of this project

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Only the scheduled tasks of this project"
    }
  }
}

mark_setup_step

Mark a step of the setup checklist completed or skipped for the person this token acts for, as the console's Mark as complete and Skip controls do; open removes the mark. Give step for one milestone, or group to mark every open step of that group (the console's Skip all). A marked step counts as done on that person's checklist and its status says how; reached stays false until SHIP sees the step done. Returns the checklist as it now stands. A token that acts for no person is refused.

Argument	Type	Description
mark*	string	open removes the caller's mark.
step	string	The milestone id from get_setup_progress. Give step or group.
group	string	A group id: marks every open step of the group.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mark"
  ],
  "properties": {
    "mark": {
      "enum": [
        "completed",
        "skipped",
        "open"
      ],
      "type": "string",
      "description": "open removes the caller's mark."
    },
    "step": {
      "enum": [
        "workspace",
        "first_mission",
        "first_review",
        "first_merge",
        "preview_deployment",
        "agent_instructions",
        "mcp_servers",
        "custom_sandbox",
        "teammate",
        "steer_mission",
        "checkpoints",
        "scheduled_task",
        "agent_to_pr"
      ],
      "type": "string",
      "description": "The milestone id from get_setup_progress. Give step or group."
    },
    "group": {
      "enum": [
        "first_mission",
        "team",
        "explore"
      ],
      "type": "string",
      "description": "A group id: marks every open step of the group."
    }
  }
}

merge_mission

Merge the mission's open pull request on GitHub with the repository's own merge method; the mission then becomes done, and the merge cannot be undone from here. When the branch is out of date with its base, answers 202 with status 'updating_branch' and a message: SHIP updates the branch and merges once CI passes, with no further call. Answers 409 with the reason for any other blocker (missing reviews, failing checks, another branch protection). On a merge conflict SHIP starts the builder to fix it and merges once the mission is ready again, with no further call. Requires the missions:write scope.

destructive

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

pause_mission

Hold a mission before its next stage. The stage that runs now finishes; no agent is stopped. Use resume_mission to continue. Requires the missions:write scope and a role that can control missions.

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

refresh_mcp_server_tools

Snapshot the bound server's current tools (with their readOnlyHint / destructiveHint annotations) for approval. Approvals of tools that no longer exist are dropped. The binding must be ready; a server inside the sandbox has no gateway tool list. Requires config:write.

destructive

Argument	Type	Description
projectId*	string	Project id, e.g. from list_projects
serverName*	string	Server name as the repository's MCP file declares it (see list_mcp_servers)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "serverName"
  ],
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    },
    "serverName": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
      "description": "Server name as the repository's MCP file declares it (see list_mcp_servers)"
    }
  }
}

request_more_credits

Ask for more credits for the workspace, saying what they are for. Any member may ask. The answer says who has the request: SHIP for a sponsored or Enterprise workspace, its owners and admins otherwise. A message sent while a request is open joins it.

Argument	Type	Description
message*	string	What the credits are for.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "What the credits are for."
    }
  }
}

resume_mission

Continue a paused mission. When a checkpoint holds it (get_mission shows pauseSource 'checkpoint:<role>'), this approves that stage's result and starts the next stage. To ask for changes to the result instead, use send_mission_instruction. Requires the missions:write scope.

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

run_scheduled_task

Fire a scheduled task immediately, bypassing both its schedule and the skip-if-previous-open guard — an explicit run always creates a new issue even while a prior fire's mission is still open. Requires the pipeline:control capability and, for a token caller, the missions:run scope — the same authorization starting a mission by hand requires, because it is the same act.

Argument	Type	Description
scheduledTaskId*	string	Scheduled task id to fire

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "scheduledTaskId"
  ],
  "properties": {
    "scheduledTaskId": {
      "type": "string",
      "description": "Scheduled task id to fire"
    }
  }
}

save_sandbox_registry

Store (or replace) the credential for a registry host. The platform attaches it to sandbox requests for that host only; it never enters a sandbox and is never returned.

destructive

Argument	Type	Description
host*	string	Registry host or URL, e.g. npm.pkg.github.com
scheme*	string	How the registry takes the credential: 'bearer' sends secret as a token, 'basic' sends username and secret
secret*	string	Token or password
username	string	Required for basic

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "host",
    "scheme",
    "secret"
  ],
  "properties": {
    "host": {
      "type": "string",
      "minLength": 1,
      "description": "Registry host or URL, e.g. npm.pkg.github.com"
    },
    "scheme": {
      "enum": [
        "bearer",
        "basic"
      ],
      "type": "string",
      "description": "How the registry takes the credential: 'bearer' sends secret as a token, 'basic' sends username and secret"
    },
    "secret": {
      "type": "string",
      "minLength": 1,
      "description": "Token or password"
    },
    "username": {
      "type": "string",
      "minLength": 1,
      "description": "Required for basic"
    }
  }
}

save_sandbox_template

Create a sandbox (omit templateId) or change one. A definition is Dockerfile steps on the platform base (RUN, ENV, ARG, WORKDIR, USER; no FROM). A changed definition or size becomes a new version and is built at once; the response carries that build. Refusals name the line or the size bound.

Argument	Type	Description
name	string	Required when creating
size	any	A tier, or { vcpu, memoryMib, diskMb } within 1-4 vCPU, >=3072 MiB per vCPU, <=12288 MiB, 8000-20000 MB
starterId	string	Create from a starter's definition and size
dockerfile	string	The Dockerfile that builds the sandbox image. Give this or starterId to create; it replaces the file on an update
templateId	string	Sandbox id (sbt_...)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Required when creating"
    },
    "size": {
      "anyOf": [
        {
          "enum": [
            "standard-1",
            "standard-2",
            "standard-3",
            "standard-4"
          ],
          "type": "string"
        },
        {
          "type": "object",
          "required": [
            "vcpu",
            "memoryMib",
            "diskMb"
          ],
          "properties": {
            "vcpu": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            },
            "diskMb": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            },
            "memoryMib": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            }
          }
        }
      ],
      "description": "A tier, or { vcpu, memoryMib, diskMb } within 1-4 vCPU, >=3072 MiB per vCPU, <=12288 MiB, 8000-20000 MB"
    },
    "starterId": {
      "type": "string",
      "description": "Create from a starter's definition and size"
    },
    "dockerfile": {
      "type": "string",
      "minLength": 1,
      "description": "The Dockerfile that builds the sandbox image. Give this or starterId to create; it replaces the file on an update"
    },
    "templateId": {
      "type": "string",
      "description": "Sandbox id (sbt_...)"
    }
  }
}

send_mission_instruction

Tell a mission what to change. Use kind='follow_up' (the default) to ask for a change: the instruction reaches the agents AND dispatches the builder against the mission's open pull request, overriding cached review and QA verdicts. Use kind='note' to record context for whatever runs next without starting any work. A restart is a different thing: it re-evaluates an unchanged pull request against its cached verdicts, and so changes nothing. Returns a receipt saying what was recorded and what it will cause. This tool calls the SHIP API, documented at https://letsship.ai/docs/api. Requires the missions:write token scope.

Argument	Type	Description
body*	string	What the agents should do. Travels verbatim into the prompt
kind	string	follow_up (default) dispatches the builder; note records context and dispatches nothing
issueId*	string	Issue id the mission is tracked under, e.g. SHIP-244 or GH-1280

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "body"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1,
      "description": "What the agents should do. Travels verbatim into the prompt"
    },
    "kind": {
      "enum": [
        "follow_up",
        "note"
      ],
      "type": "string",
      "description": "follow_up (default) dispatches the builder; note records context and dispatches nothing"
    },
    "issueId": {
      "type": "string",
      "description": "Issue id the mission is tracked under, e.g. SHIP-244 or GH-1280"
    }
  }
}

set_agents_override

Patch one role's harness/model/effort/prompt for a single mission, layered over ship.yml per-field (a role or field this call omits keeps resolving from ship.yml — SHIP-337). Use promptContent or promptPath(+promptRef) to run an ephemeral prompt experiment (spec D9) without committing to the target repo. Read-modify-write: this call is merged onto the previously stored override record (via get_agents_override), so a prior set for a DIFFERENT role — or a different field on this same role, e.g. an earlier harness pin — survives; the underlying PUT is a full-record replace and would otherwise silently drop it. This tool calls the SHIP API, documented at https://letsship.ai/docs/api.

destructive

Argument	Type	Description
role*	string	The role this override entry patches
size	any	Container size for this role on this mission
model	string	The model id this role uses for this mission. The harness must support it
effort	string	Reasoning effort for this role, mapped to the harness's own control at dispatch: low, medium, high or xhigh, and also max on claude-code. A value the harness does not take is refused at dispatch.
harness	string	The code harness this role runs on for this mission
issueId*	string

set_mcp_config_path

Point the project at the repository file that declares its MCP servers, e.g. .cursor/mcp.json or .vscode/mcp.json. null restores the default (.mcp.json). The file is read, never edited. When the repository's ship.yml sets mcp.config, that wins and this call is refused (409); list_mcp_servers reports which one applies as configPathSource. Requires the config:write capability.

Argument	Type	Description
projectId*	string	Project id, e.g. from list_projects
configPath*	any	Repository-relative path, or null

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "configPath"
  ],
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    },
    "configPath": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 256,
          "minLength": 1
        },
        {
          "type": "null"
        }
      ],
      "description": "Repository-relative path, or null"
    }
  }
}

set_mission_auto_merge

Set whether SHIP merges this mission's pull request by itself once the checks, the review and the test pass. The setting is for this mission only and replaces the project's auto-merge for it; get_project shows the project's. While it is on, SHIP merges without asking again. Requires the missions:write scope.

destructive

Argument	Type	Description
enabled*	boolean	true merges the pull request once it is ready; false leaves the merge to a person
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "true merges the pull request once it is ready; false leaves the merge to a person"
    },
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

set_mission_disposition

Record a person's reason for how a mission ended, which the delivery statistics use: product (real work, judged on its merits), probe (a test on purpose), superseded (another mission replaced it: give supersededBy) or takeover (a person finished the work outside SHIP); null clears it. Set it only with the person's answer, never from your own guess. Requires the missions:write scope and the config:write capability.

destructive

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412
disposition*	any	product, probe, superseded or takeover; null clears a disposition set by mistake
supersededBy	string	The issue id of the mission that replaced this one, for disposition superseded only

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "disposition"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    },
    "disposition": {
      "anyOf": [
        {
          "enum": [
            "product",
            "probe",
            "superseded",
            "takeover"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "product, probe, superseded or takeover; null clears a disposition set by mistake"
    },
    "supersededBy": {
      "type": "string",
      "minLength": 1,
      "description": "The issue id of the mission that replaced this one, for disposition superseded only"
    }
  }
}

start_credit_checkout

Opens a payment page and returns its URL. Nothing is charged until the buyer pays on that page. It sells one credit pack, a monthly plan (offer team, with teamPlan starter or scale, a subscription that renews until cancelled), or extra credits for a workspace already on a plan (offer team_credits, for quantity credits at that plan's own price per credit, paid once, expiring with the plan month). Only a workspace on a plan can use team_credits. Only owners and admins can open a page. The server refuses the request while startNow is false, and the same idempotencyKey returns the same page.

destructive

Argument	Type	Description
offer*	string	A pack, team or team_credits, from list_credit_offers.
quantity	integer	Credits for team_credits, within the range list_credit_offers gives; omit for a pack or a plan.
startNow*	boolean	Records the buyer's own consent to start the credits at once, during the withdrawal period, against this text: "Start my credits now, so they can be used during the 14-day withdrawal period. If I withdraw, I pay for the credits I used; I lose the right to withdraw once all the credits I am buying are used." The server refuses the request while it is false.
teamPlan	string	The plan to start, for offer team only: starter or scale, from list_credit_offers.
idempotencyKey	string	Reuse on retry to get the same page back.

start_mcp_server_oauth

Begin the OAuth consent for a server bound as remote. Returns an authorizeUrl that a HUMAN must open in a browser signed in to the SHIP console as the same user this token acts for; the provider returns to the console, which stores the credential. The link is single-use and expires (expiresAt). An agent cannot complete the consent itself. Requires config:write.

Argument	Type	Description
scope	string	Requested scope; defaults to the server's own hint
returnTo	string	Console path to land on after consent, e.g. /projects/<id>
projectId*	string	Project id, e.g. from list_projects
serverName*	string	Server name as the repository's MCP file declares it (see list_mcp_servers)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "serverName"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "maxLength": 512,
      "description": "Requested scope; defaults to the server's own hint"
    },
    "returnTo": {
      "type": "string",
      "pattern": "^\\/",
      "maxLength": 512,
      "description": "Console path to land on after consent, e.g. /projects/<id>"
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    },
    "serverName": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
      "description": "Server name as the repository's MCP file declares it (see list_mcp_servers)"
    }
  }
}

start_mission

Hand a mission off to the AI agent team. Omit startAt for the default full run (planner first); pass startAt='builder' with a plan to skip straight to coding; pass startAt='reviewer' or startAt='qa' with an existing prNumber to hand off an existing build. Requires the missions:run token scope.

Argument	Type	Description
plan	string	Hand-off plan markdown, for startAt='builder'
agents	object	Per-role harness/model override for THIS mission only; overrides ship.yml without changing it
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-244 or WEB-42
startAt	string	Pipeline stage to enter at; omit for the default full run starting at the planner
prNumber	integer	Existing open PR number, required for startAt='reviewer' or startAt='qa'
projectId*	string	Project id the mission belongs to

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "projectId"
  ],
  "properties": {
    "plan": {
      "type": "string",
      "description": "Hand-off plan markdown, for startAt='builder'"
    },
    "agents": {
      "type": "object",
      "properties": {
        "qa": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "builder": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "planner": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "reviewer": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "description": "Per-role harness/model override for THIS mission only; overrides ship.yml without changing it",
      "additionalProperties": false
    },
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-244 or WEB-42"
    },
    "startAt": {
      "enum": [
        "builder",
        "reviewer",
        "qa"
      ],
      "type": "string",
      "description": "Pipeline stage to enter at; omit for the default full run starting at the planner"
    },
    "prNumber": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing open PR number, required for startAt='reviewer' or startAt='qa'",
      "exclusiveMinimum": 0
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to"
    }
  }
}

stop_agent_run

Stop the agent in one run before it finishes. Its work in progress is lost, and the run's status becomes stopped a few seconds later. Needs an org admin and the sandboxes:stop scope. This stops one agent run, not the mission: to stop the whole mission, use POST /v1/missions/{issueId}/stop.

destructive

Argument	Type	Description
sandboxId*	string	Agent run id: the run's sandbox id, from list_agent_runs

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sandboxId"
  ],
  "properties": {
    "sandboxId": {
      "type": "string",
      "description": "Agent run id: the run's sandbox id, from list_agent_runs"
    }
  }
}

stop_mission

Hard-stop a mission: every agent run of it stops and its work in progress is lost. The pull request stays open, and start_mission starts the mission again. To stop one agent run only, use stop_agent_run. Requires the missions:write scope.

destructive

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

unarchive_mission

Show an archived mission in list_missions and on the board again. Requires the missions:write scope and the config:write capability.

Argument	Type	Description
issueId*	string	The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId"
  ],
  "properties": {
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-412"
    }
  }
}

unbind_mcp_server

Delete a binding and its stored credential: no role receives the server from its next run. The repository's MCP file is not changed, so the server can be bound again. Requires config:write.

destructive

Argument	Type	Description
projectId*	string	Project id, e.g. from list_projects
serverName*	string	Server name as the repository's MCP file declares it (see list_mcp_servers)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "serverName"
  ],
  "properties": {
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    },
    "serverName": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
      "description": "Server name as the repository's MCP file declares it (see list_mcp_servers)"
    }
  }
}

update_project

Change the settings of one project; a field you leave out keeps its value. status paused or archived stops new missions in the project, and active starts them again. autoMerge sets whether SHIP merges a ready pull request by itself. defaultSandboxTemplateId sets the sandbox the agents start in (null for the platform base). repoFullName, linearTeamKey and jiraProjectId connect the project to another repository, Linear team or Jira project through the organization's existing connections. Change only what a person asked for. Answers the project as it now stands. Requires the projects:admin scope and the config:write capability.

destructive

Argument	Type	Description
name	string	A new name
status	string	active, paused or archived
autoMerge	boolean	true merges a ready pull request without a person
issueCode	string	A GitHub Issues project's issue id prefix, 2-5 characters; only new ids use it
projectId*	string	Project id, from list_projects
repoFullName	string	owner/repo of the repository to connect, through the organization's GitHub connection
jiraProjectId	string

update_scheduled_task

Patch a scheduled task's name, prompt, schedule, skip-guard, or enabled state — only the fields passed are changed. To change the schedule, set interval/time/timezone together (plus weekday or dayOfMonth as the interval requires). This tool calls the SHIP API, documented at https://letsship.ai/docs/api. Requires the config:write capability.

destructive

Argument	Type	Description
name	string	Scheduled task name, shown in the console and used in the issue title
time	string	24-hour wall-clock time in `timezone`, e.g. '09:00'.
labels	array	Tracker label names put on every issue this scheduled task files (replaces the list; [] clears it). The label must ALREADY exist in the project's tracker team — the platform attaches labels but cannot create them, so a name the workspace does not have is dropped.
prompt	string	Replaces the issue description verbatim
enabled	boolean	Set false to pause the schedule without deleting the scheduled task
weekday	string	Day of week — required when interval is 'weekly'.
interval	string	Fire cadence. 'weekly' requires weekday; 'monthly' requires dayOfMonth.

update_team_subscription

Change the workspace's monthly plan subscription: plan switches between starter and scale from the next renewal on (nothing is charged or refunded for the current month; passing the current plan drops a waiting switch), or cancelAtPeriodEnd true ends it when the month already paid for ends, false resumes it before then. Pass at least one. Owners and admins only. The answer is the subscription as it now stands, with any waiting switch under nextPlan.

destructive

Argument	Type	Description
plan	string	The plan from the next renewal on: starter or scale, from list_credit_offers.
cancelAtPeriodEnd	boolean	true ends the subscription at the end of the paid month; false resumes it.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "plan": {
      "enum": [
        "starter",
        "scale"
      ],
      "type": "string",
      "description": "The plan from the next renewal on: starter or scale, from list_credit_offers."
    },
    "cancelAtPeriodEnd": {
      "type": "boolean",
      "description": "true ends the subscription at the end of the paid month; false resumes it."
    }
  }
}

watch_agent_run

Wait on one agent run and follow what its agent does, instead of polling get_agent_run. The call returns when the run ends, when its mission moves to another stage, or after maxSeconds. While it waits, each agent event (a thought, a tool call, a plan update, an error) is sent as a progress notification when the request has a progress token. The result has the status of the run, the stage of its mission, ended, the reason it returned, the last 20 events and a cursor. When the run is still running, call it again with since set to the cursor. A run that already ended returns at once. If your client ends a call after 60 seconds, set maxSeconds below that.

read-only

Argument	Type	Description
since	integer	The cursor from an earlier result. Only the events after it are sent
sandboxId*	string	Agent run id: the run's sandbox id, from list_agent_runs or get_mission
maxSeconds	integer	The longest time to wait, in seconds (default 300, at most 600)

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sandboxId"
  ],
  "properties": {
    "since": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "The cursor from an earlier result. Only the events after it are sent"
    },
    "sandboxId": {
      "type": "string",
      "description": "Agent run id: the run's sandbox id, from list_agent_runs or get_mission"
    },
    "maxSeconds": {
      "type": "integer",
      "default": 300,
      "maximum": 600,
      "minimum": 1,
      "description": "The longest time to wait, in seconds (default 300, at most 600)"
    }
  }
}

whoami

Returns the caller's identity, org, role, role-derived RBAC capabilities, and token scopes. Use this to check whether the current token may perform an action (e.g. config:write) before attempting it.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "serverName",
    "roles"
  ],
  "properties": {
    "roles": {
      "type": "array",
      "items": {
        "enum": [
          "planner",
          "builder",
          "reviewer",
          "qa"
        ],
        "type": "string"
      },
      "maxItems": 4,
      "description": "Every role that may use the server ([] disables it)"
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id, e.g. from list_projects"
    },
    "remoteUrl": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "A fixed https URL: a hosted endpoint for a command server, or an override for a URL server"
    },
    "transport": {
      "enum": [
        "remote",
        "isolate",
        "local"
      ],
      "type": "string",
      "description": "How the gateway reaches the server: 'remote' proxies to remoteUrl, 'isolate' runs the server's npm package away from the sandbox so a secret stays out of it, and 'local' runs the command inside the sandbox with no credential. Omit it on an update to keep the server the binding is pinned to."
    },
    "credential": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "kind"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "none"
            }
          }
        },
        {
          "type": "object",
          "required": [
            "kind",
            "headers"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "headers"
            },
            "headers": {
              "type": "object",
              "description": "Header name to value, 1-10 entries, e.g. { Authorization: 'Bearer ...' }. Remote servers only.",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "string",
                "maxLength": 4096,
                "minLength": 1
              }
            }
          }
        },
        {
          "type": "object",
          "required": [
            "kind",
            "env",
            "allowedHosts"
          ],
          "properties": {
            "env": {
              "type": "object",
              "description": "Environment variable to value, 1-20 entries. Isolated servers only.",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "string",
                "maxLength": 4096,
                "minLength": 1
              }
            },
            "kind": {
              "type": "string",
              "const": "isolate-env"
            },
            "allowedHosts": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 253,
                "minLength": 1
              },
              "maxItems": 10,
              "minItems": 1,
              "description": "Exact hostnames the isolated server may reach; the credential can go nowhere else."
            }
          }
        }
      ],
      "description": "Write-only credential the gateway attaches; agents never receive it. Omit to keep the stored one. OAuth credentials are not set here: bind as remote with kind 'none', then start_mcp_server_oauth."
    },
    "serverName": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$",
      "description": "Server name as the repository's MCP file declares it (see list_mcp_servers)"
    },
    "approvedTools": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 128,
            "minLength": 1
          },
          "attestedReadOnly": {
            "type": "boolean",
            "description": "Owner attestation that an UNANNOTATED tool only reads; lets reviewer and qa use it"
          }
        }
      },
      "maxItems": 200,
      "description": "The approved subset of the tool snapshot (refresh_mcp_server_tools first). Omit to keep it."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId"
  ],
  "properties": {
    "title": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Issue title. Omit ONLY with entryPrNumber — the pull request's own title is then used"
    },
    "agents": {
      "type": "object",
      "properties": {
        "qa": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "builder": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "planner": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        },
        "reviewer": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "minLength": 1
            },
            "harness": {
              "enum": [
                "claude-code",
                "codex",
                "pi",
                "kilo-code",
                "open-code"
              ],
              "type": "string"
            }
          },
          "additionalProperties": false
        }
      },
      "description": "Per-role harness/model override for THIS mission only; overrides ship.yml without changing it",
      "additionalProperties": false
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 10,
      "description": "Tracker labels to apply"
    },
    "entryPlan": {
      "type": "string",
      "description": "Hand-off plan markdown, for entryStartAt='builder'"
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to"
    },
    "description": {
      "type": "string",
      "maxLength": 10000,
      "description": "Issue body; acceptance criteria written here are parsed as they would be on any issue"
    },
    "entryStartAt": {
      "enum": [
        "builder",
        "reviewer",
        "qa"
      ],
      "type": "string",
      "description": "Pipeline stage to enter at; omit for the default full run starting at the planner"
    },
    "entryPrNumber": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Existing open PR number, required for entryStartAt='reviewer' or 'qa'",
      "exclusiveMinimum": 0
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "projectId",
    "name",
    "prompt",
    "interval",
    "time",
    "timezone"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Scheduled task name, shown in the console and used in the issue title"
    },
    "time": {
      "type": "string",
      "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
      "description": "24-hour wall-clock time in `timezone`, e.g. '09:00'."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 10,
      "description": "Tracker label names put on every issue this scheduled task files (default none). The label must ALREADY exist in the project's tracker team — the platform attaches labels but cannot create them, so a name the workspace does not have is dropped."
    },
    "prompt": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "Becomes the created issue's description verbatim on every fire"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the schedule is armed (default true)"
    },
    "weekday": {
      "enum": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday",
        "saturday",
        "sunday"
      ],
      "type": "string",
      "description": "Day of week — required when interval is 'weekly'."
    },
    "interval": {
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ],
      "type": "string",
      "description": "Fire cadence. 'weekly' requires weekday; 'monthly' requires dayOfMonth."
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "description": "IANA timezone id, e.g. 'Europe/Amsterdam'."
    },
    "projectId": {
      "type": "string",
      "minLength": 1,
      "description": "Project id the scheduled task belongs to"
    },
    "dayOfMonth": {
      "type": "integer",
      "maximum": 28,
      "minimum": 1,
      "description": "Day of month, 1-28 — required when interval is 'monthly' (capped at 28 so every month has the day)."
    },
    "templateKey": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Attribution only, when authored from a template — see list_scheduled_task_templates"
    },
    "skipIfPreviousOpen": {
      "type": "boolean",
      "description": "Skip a scheduled fire while the previous fire's mission is still open (default true — the guardrail is opt-out, not opt-in)"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "issueId",
    "projectId",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "planner",
        "builder",
        "reviewer",
        "qa"
      ],
      "type": "string",
      "description": "The role this override entry patches"
    },
    "size": {
      "anyOf": [
        {
          "enum": [
            "standard-1",
            "standard-2",
            "standard-3",
            "standard-4"
          ],
          "type": "string"
        },
        {
          "type": "object",
          "required": [
            "vcpu",
            "memoryMib",
            "diskMb"
          ],
          "properties": {
            "vcpu": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            },
            "diskMb": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            },
            "memoryMib": {
              "type": "integer",
              "maximum": 9007199254740991,
              "minimum": -9007199254740991
            }
          }
        }
      ],
      "description": "Container size for this role on this mission"
    },
    "model": {
      "type": "string",
      "minLength": 1,
      "description": "The model id this role uses for this mission. The harness must support it"
    },
    "effort": {
      "type": "string",
      "minLength": 1,
      "description": "Reasoning effort for this role, mapped to the harness's own control at dispatch: low, medium, high or xhigh, and also max on claude-code. A value the harness does not take is refused at dispatch."
    },
    "harness": {
      "enum": [
        "claude-code",
        "codex",
        "pi",
        "kilo-code",
        "open-code"
      ],
      "type": "string",
      "description": "The code harness this role runs on for this mission"
    },
    "issueId": {
      "type": "string",
      "description": "The mission's issue id: a Linear key or a GitHub Issues id, e.g. SHIP-353 or WEB-42"
    },
    "sandbox": {
      "type": "string",
      "minLength": 1,
      "description": "Sandbox name or id this role starts in for this mission (beats ship.yml and the project default)"
    },
    "rejectOn": {
      "enum": [
        "critical",
        "suggestion",
        "trivial"
      ],
      "type": "string",
      "description": "Review rejection threshold — only meaningful on the reviewer role"
    },
    "projectId": {
      "type": "string",
      "description": "Project id the mission belongs to"
    },
    "promptRef": {
      "type": "string",
      "minLength": 1,
      "description": "Git ref for promptPath — only meaningful alongside promptPath."
    },
    "baseBranch": {
      "type": "string",
      "minLength": 1,
      "description": "Override the pipeline's fork/target branch for this mission"
    },
    "checkpoint": {
      "type": "boolean",
      "description": "Pause the pipeline after this role's stage completes"
    },
    "promptMode": {
      "enum": [
        "replace",
        "extend"
      ],
      "type": "string",
      "description": "How this prompt relates to the repo's own .ship/agents/<role>.md (or ship.yml-pointed) layer. replace (default) makes this the role's only role-prompt layer; extend resolves the repo's layer first and appends this content after it, as a separately attributed span. Only meaningful with promptContent or promptPath. NOTE: the merge is per FIELD, and prompt is one field — a later call that sets a new promptContent/promptPath without repeating promptMode replaces the whole stored prompt, reverting to replace."
    },
    "promptPath": {
      "type": "string",
      "maxLength": 512,
      "minLength": 1,
      "description": "Repo-relative path to an L2 prompt file. Without promptRef this is the SHIP-347 pointer form (resolved at the pinned base branch); with promptRef it's a path+ref experiment resolved at that ref."
    },
    "promptContent": {
      "type": "string",
      "maxLength": 30000,
      "minLength": 1,
      "description": "Inline prompt-experiment body, capped at 30,000 characters. Mutually exclusive with promptPath."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "scheduledTaskId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 120,
      "minLength": 1,
      "description": "Scheduled task name, shown in the console and used in the issue title"
    },
    "time": {
      "type": "string",
      "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
      "description": "24-hour wall-clock time in `timezone`, e.g. '09:00'."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 10,
      "description": "Tracker label names put on every issue this scheduled task files (replaces the list; [] clears it). The label must ALREADY exist in the project's tracker team — the platform attaches labels but cannot create them, so a name the workspace does not have is dropped."
    },
    "prompt": {
      "type": "string",
      "maxLength": 20000,
      "minLength": 1,
      "description": "Replaces the issue description verbatim"
    },
    "enabled": {
      "type": "boolean",
      "description": "Set false to pause the schedule without deleting the scheduled task"
    },
    "weekday": {
      "enum": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday",
        "saturday",
        "sunday"
      ],
      "type": "string",
      "description": "Day of week — required when interval is 'weekly'."
    },
    "interval": {
      "enum": [
        "daily",
        "weekly",
        "monthly"
      ],
      "type": "string",
      "description": "Fire cadence. 'weekly' requires weekday; 'monthly' requires dayOfMonth."
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "description": "IANA timezone id, e.g. 'Europe/Amsterdam'."
    },
    "dayOfMonth": {
      "type": "integer",
      "maximum": 28,
      "minimum": 1,
      "description": "Day of month, 1-28 — required when interval is 'monthly' (capped at 28 so every month has the day)."
    },
    "scheduledTaskId": {
      "type": "string",
      "description": "Scheduled task id to update"
    },
    "skipIfPreviousOpen": {
      "type": "boolean",
      "description": "Skip a scheduled fire while the previous fire's mission is still open (default true — the guardrail is opt-out, not opt-in)"
    }
  }
}