Shipyard

Provides an MCP server to manage Shipyard environments via AI assistants including environments, services, volumes, and org management.

typescript

7

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "shipyard-shipyard-cli": {
      "command": "shipyard",
      "args": [
        "mcp",
        "serve"
      ],
      "env": {
        "SHIPYARD_ORG": "YOUR_ORG",
        "SHIPYARD_API_TOKEN": "YOUR_TOKEN"
      }
    }
  }
}

You can run an MCP server for Shipyard to let AI assistants manage environments, services, volumes, and organizational settings directly through commands you run or via integration with your preferred MCP clients. This guide shows you how to set up and use the Shipyard MCP server so your AI tools can perform common Shipyard operations safely and efficiently.

How to use

You’ll enable an MCP server that runs locally and exposes the Shipyard management capabilities to your MCP clients. The primary workflow is to start the Shipyard MCP server and then configure your MCP client to connect to it. Once connected, you can perform actions such as listing environments, inspecting environment details, managing services and volumes, and handling organizational context through the MCP tooling.

How to install

Prerequisites you should have before enabling the MCP server include Node.js/npm or another runtime compatible with Shipyard’s CLI, and access to the Shipyard CLI build if you’re integrating MCP locally.

Linux and macOS you install the Shipyard CLI by running this command in your terminal:

curl https://www.shipyard.sh/install.sh | bash

Windows users should download the executable for Windows from the releases page and run it, or install via the Shipyard CLI workflow if you prefer to run through a cross-platform installer.

If you use Homebrew, you can install the Shipyard CLI with these commands:

brew tap shipyard/tap
brew install shipyard

Available tools

get_environments

List environments with filtering options to narrow down results by name, branch, repo, or status.

get_environment

Get detailed information for a specific environment by its UUID.

stop_environment

Stop a running environment to free up resources.

restart_environment

Restart a stopped environment to reinitialize it.

rebuild_environment

Rebuild an environment using the latest commit.

cancel_environment

Cancel the latest build for an environment.

revive_environment

Revive a deleted environment to restore access.

get_services

List all services within a given environment.

get_logs

Retrieve logs for a specific service in an environment.

get_volumes

List volumes attached to an environment.

reset_volume

Reset a volume to its initial state.

get_snapshots

List volume snapshots for an environment.

create_snapshot

Create a new volume snapshot.

load_snapshot

Load a snapshot into a volume.

get_orgs

List all organizations accessible to your account.

get_org

Get the current default organization.

set_org

Set the default organization for subsequent MCP operations.

exec_service

Execute commands inside a service container (limited helper tool).

port_forward

Port-forward a service port to your local machine (limited helper tool).

telepresence_connect

Connect to a service namespace via Telepresence (limited helper tool).