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 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 say
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.
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.
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
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, f
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 re
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.
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 han
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
Record why the person this token acts for will not finish setting up SHIP, in their words: for example no repository yet, no wish to set up model keys or credits, or no time now. Call it only after the person said why. Ask them when get_setup_progress shows setup is not done and they say they will s
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 don
List the projects accessible to the calling principal. Returns id, slug, name, status, createdAt for each. An empty list means the workspace is not set up yet: no mission can run until the person connects GitHub and a model key and creates a project in the SHIP console. Call get_setup_progress and g
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
Move the repository that SHIP made for a project with Start from scratch into the person's own empty GitHub repository, or name that repository for a transfer that waits on it. Only the repository moves. The hosted site, its waitlist, its database and SHIP's models, paid in credits, stay. SHIP archi
Read the transfer of a project's repository to the person's GitHub account: its state, what the person does next, where the repository goes, and when SHIP deletes its archived copy. This tool only reads: SHIP moves the transfer on by itself. The result gives the next step in action: choose_target me
Stop the transfer of a project's repository before the project uses the new repository. The project keeps SHIP's copy, and SHIP writes nothing more to the person's repository. Only an owner of the workspace can do this.
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.
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 th
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
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 sta
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.
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
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.
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.
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.
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 mission
A mission waits at the QA checkpoint (get_mission shows pauseSource 'qa-unverifiable') when QA could not check some acceptance criteria, so no code change can move it. A person checks those criteria another way, then answers. 'accept' counts QA as passed, 'reject' ends the mission as failed, and 're
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 o
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.
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:wri
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).
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 wi
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 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.
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.
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, docume
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/
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 authori
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 tha
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.
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
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.
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
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), 'isolat
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.
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.
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 a
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
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.
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 th
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 notificat
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.
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.
FAQ
Pertanyaan
Bagaimana cara menginstal SHIP?
Salin konfigurasi http untuk Cursor, Claude Desktop, Claude Code, atau VS Code di halaman ini. Konfigurasi ini memakai instalasi dari penerbit, bukan proxy PlugMCP.
Apakah SHIP memerlukan kunci API?
Tidak ada variabel lingkungan wajib yang tercantum di catatan ini.
Transport apa yang digunakan SHIP?
SHIP diakses melalui HTTP.
Kapan SHIP terakhir diperiksa?
Terakhir diperiksa 2026-11-13. Assign Linear, Jira or GitHub issues to an AI coding agent team that plans, builds, reviews, tests.
Dari penerbit
Dokumentasi
SHIP MCP server
Assign Linear, Jira or GitHub issues to an AI coding agent team. Its coding agents plan and build each change, run code review and tests, and open a pull request in your GitHub repository. With this MCP server, your assistant can file missions, follow them, send instructions and read the proof of each run.
SHIP runs an agentic SDLC as a headless AI software factory. You operate the whole mission from your coding agent or AI assistant. Start it, send instructions, read its code review and test reports, and approve the pull request. A Planner, a Builder, a Reviewer and a Tester each do one stage, and your CI is a gate between them. Each role runs the coding agent and the model that you choose: Claude Code, Codex, OpenCode, Kilo Code or the pi coding agent.
Endpoint
https://mcp.letsship.ai/mcp
The transport is Streamable HTTP. The server is stateless, so a client can reconnect at any time and lose nothing.
Sign in
OAuth 2.1. A client that supports MCP authorization finds the sign-in automatically. If a request needs a token and has no valid token, the server answers 401 with a WWW-Authenticate header.
The header points to https://mcp.letsship.ai/.well-known/oauth-protected-resource/mcp. SHIP supports dynamic client registration and client ID metadata documents, so you do not have to register a client first. You approve the sign-in in the SHIP console.
Personal access token. A client without OAuth sends Authorization: Bearer pat_.... Create a token at https://letsship.ai/settings/tokens. Bind it to one project, so that it can reach only that project.
Install
Claude Code
claude mcp add --transport http ship https://mcp.letsship.ai/mcp
Claude and ChatGPT. Add a custom connector with the URL https://mcp.letsship.ai/mcp. Sign in when the app asks.
Cursor. Use the button above, or add this to .cursor/mcp.json:
Each tool declares readOnlyHint, destructiveHint and openWorldHint. With these hints, your client can run a read-only tool immediately. It can also ask you before it runs a tool that removes or replaces something, or opens a payment page. The scopes of the token decide what each tool can do, and a refusal names the scope that the token does not have.
[!IMPORTANT]
start_mission, create_mission and run_scheduled_task start a mission, and each mission start costs one credit. Messages to an active mission are free.
Missions
Tool
Kind
What it does
start_mission
reaches outside SHIP
Give an issue that is already in your tracker to the agent team. By default, the mission starts at the Planner. With a plan, it starts at the Builder. With an open pull request, it starts at the Reviewer or the Tester
create_mission
reaches outside SHIP
Create the issue and start the mission in one call, for work that has no issue yet
send_mission_instruction
reaches outside SHIP
Tell an active mission what to change, or record a note for the agent that runs next
inspect_mission
reads
The full record of a mission: its stages, verdicts, provenance and session logs
list_missions
reads
The missions of your projects, with what each mission does now
get_mission
reads
One mission: its stage, its review and test results, its pull request, its agent runs and the run with the proof. With view: "full", also its events and the outcome of each stage
pause_mission
writes
Hold a mission before its next stage. The stage that runs now finishes
resume_mission
reaches outside SHIP
Continue a paused mission. When a checkpoint holds the mission, this approves the result of that stage
stop_mission
removes
Stop a mission and every agent run of it. The pull request stays open
approve_mission_ceiling
reaches outside SHIP
Let a mission continue after it stops at its credit limit. The mission then uses more credits
merge_mission
removes
Merge the pull request of a mission, with the merge method of the repository. On a merge conflict, SHIP starts the Builder to fix the conflict and merges later
decline_mission
removes
Close the pull request of a mission without a merge
set_agents_override
replaces
Change the harness, model, prompt or checkpoint of one role for one mission. The override goes on top of ship.yml and does not change the file
get_agents_override
reads
Read the override that applies to a mission now
clear_agents_override
removes
Remove the override, so the mission uses the project's configuration again
set_mission_auto_merge
reaches outside SHIP
Turn auto-merge on or off for one mission. For that mission, the setting replaces the auto-merge of the project
archive_mission
writes
Hide a mission from the board and from list_missions. Only an owner or an admin can archive a mission
unarchive_mission
writes
Show an archived mission on the board again
set_mission_disposition
writes
Record why a mission ended, for example a test or work that another mission replaced, or clear the value. The delivery statistics use this value
Projects and proof
Tool
Kind
What it does
list_projects
reads
The projects that the token can reach
get_project
reads
The configuration and connections of one project
update_project
reaches outside SHIP
Change the name, status, auto-merge, issue code, default sandbox or connections of a project
list_artifacts
reads
The proof that a run produced, such as test traces and screenshots
get_artifact
reads
One artifact, with a link to open it
Scheduled tasks
Tool
Kind
What it does
list_scheduled_tasks
reads
The missions that a project runs on a schedule
get_scheduled_task
reads
One scheduled task, with its schedule and prompt
create_scheduled_task
writes
Add a mission that runs on a schedule
update_scheduled_task
replaces
Change the schedule or prompt of a scheduled task, or disable it
run_scheduled_task
reaches outside SHIP
Run a scheduled task now, outside its schedule
list_scheduled_task_runs
reads
What past runs did, and what they cost
list_scheduled_task_templates
reads
Templates that you can copy to start a scheduled task
delete_scheduled_task
removes
Delete a scheduled task and its run history. Missions that the task started continue
MCP servers for your agents
Tool
Kind
What it does
list_mcp_servers
reads
The servers that the MCP file of a project declares, each with its binding and status
list_mcp_bindings
reads
Each binding in the projects of your organization, so you can see where each credential is used
bind_mcp_server
replaces
Choose the agents, transport, approved tools and credential for one server
unbind_mcp_server
removes
Remove a binding and delete its credential
refresh_mcp_server_tools
removes
Read the current tool list of the server, so that you can approve tools
start_mcp_server_oauth
reaches outside SHIP
Get a sign-in link for a remote server, for a person to open in their browser
set_mcp_config_path
writes
Set a different MCP file for a project, such as .cursor/mcp.json
Agent runs
Tool
Kind
What it does
list_agent_runs
reads
Agent runs, live and finished, for one mission, one role or one status
get_agent_run
reads
The detail and resource use of one run
get_agent_run_logs
reads
What an agent did inside a run
watch_agent_run
reads
Wait on one run and follow its events, until the run ends or its mission moves to another stage
stop_agent_run
removes
Stop the agent in one run before it finishes
Preview environments
Tool
Kind
What it does
list_environments
reads
Preview environments that SHIP deployed for open pull requests
get_environment
reads
One preview environment, with its URL
destroy_environment
removes
Remove a preview environment early
Credits and notices
Tool
Kind
What it does
get_billing
reads
The credit balance, the credit limit for each mission and the recent use. Read it before you send work
list_billing_ledger
reads
Where the credits went, with the newest entry first
list_credit_offers
reads
The credit packs and the monthly plans, with their prices
start_credit_checkout
reaches outside SHIP
Open a payment page for a credit pack, a monthly plan or more credits on a plan, and return its URL
update_team_subscription
removes
Change the monthly plan from the next renewal, or cancel it at the end of the month that you paid for
request_more_credits
reaches outside SHIP
Ask for more credits. The answer says who has the request
get_notices
reads
What needs attention in the workspace, such as a tracker that you must connect again
dismiss_notice
writes
Close a notice that you can close, such as a low balance
Custom sandboxes
Tool
Kind
What it does
list_sandbox_templates
reads
The sandboxes of your organization, with the active version and the latest build of each
list_sandbox_starters
reads
Sandbox definitions for Python, Java, Go, Rust and Ruby that you can start from
save_sandbox_template
writes
Create a sandbox or change one. A change makes a new version and starts its build
list_sandbox_template_versions
reads
Each saved version of a sandbox, with the active version marked
activate_sandbox_template_version
writes
Make a version the one that missions use from their next run
build_sandbox_template
writes
Build the active version now
get_sandbox_build_log
reads
One page of a build log
list_sandbox_registries
reads
The private package registries that sandboxes install from. A secret is never returned
save_sandbox_registry
replaces
Store or replace the credential for a registry. The credential never enters a sandbox
get_sandbox_capacity
reads
How many agents your missions run at once, against the limit of your organization
delete_sandbox_template
removes
Delete a sandbox. The API refuses a sandbox that an agent or the default of a project uses
delete_sandbox_registry
removes
Remove the credential of a private registry
Platform operators
Tool
Kind
What it does
list_orgs
reads
Each organization on the platform. Only a SHIP operator token can call it
Identity
Tool
Kind
What it does
whoami
reads
The principal behind the token and the scopes of the token
get_setup_progress
reads
What the workspace has set up so far and the next step, as the console's setup checklist shows it
healthz
reads
The status, environment and version of the API
Example: file a fix and answer the review
Call list_projects to get the project id.
Call create_mission to file the issue and start the mission. Write the acceptance criteria as checkboxes, because the Tester uses them to test the work.
The agents plan the change, build it and open a pull request. Then they wait for your CI, review the change, deploy a preview and test it. This takes tens of minutes, and your assistant does not have to wait.
Call inspect_mission to read the stage and the verdicts. To disagree with a review, call send_mission_instruction with kind: "follow_up". The Builder then works on the pull request again and follows your instruction.
To send feedback, use send_mission_instruction. Do not call start_mission again, because a restart does not take a message.
Troubleshooting
What you see
What to do
401 and no sign-in window
Your client does not support MCP OAuth. Send a personal access token in the Authorization header.
A tool refuses with a scope name
The token does not have that scope. Create a token that has the scope, or ask an owner for a role that allows it.
create_mission refuses with credits_exhausted
The workspace has no credits left. get_billing shows the balance.
The tool list is empty, or each tool call gets 401
The client did not finish sign-in. Sign in again from the MCP menu of your client, or remove the server and add it again.
whoami names another project
The token is bound to that project. Use a token for the project you want.
Skills for your coding agent
The SHIP skills teach a coding agent to hand work to SHIP from the terminal. To install them, see letsship/skills or run npx skills add https://letsship.ai.