Skip to main content

Shipyard MCP

Beta release

This feature is still in Beta.

The Shipyard CLI provides a Model Context Protocol (MCP) server for AI assistant integration. This allows AI assistants like Claude Code to manage Shipyard environments directly.

Shipyard MCP with Claude Code

You can use this for writing/running tests, smart code reviews, incident triage, and debugging with agents (among many other things).

tip

Use the Shipyard MCP integration with the Playwright MCP integration for visual testing with agents against your Shipyard environments.

Learn more: Playwright MCP on GitHub

Installation

In order to use the MCP, you must first install the Shipyard CLI.

brew tap shipyard/tap
brew install shipyard

Setup

With API token and org name:

claude mcp add shipyard --env SHIPYARD_API_TOKEN=your-token-here --env SHIPYARD_ORG=your-org-name -- shipyard mcp serve

If already configured with CLI:

claude mcp add shipyard -- shipyard mcp serve

Supported MCP Tools

Environment Management (7 tools)

  • get_environments - List environments with filtering
  • get_environment - Get specific environment details
  • stop_environment - Stop a running environment
  • restart_environment - Restart a stopped environment
  • rebuild_environment - Rebuild with latest commit
  • cancel_environment - Cancel environment's latest build
  • revive_environment - Revive a deleted environment

Service Management (2 tools)

  • get_services - List services in an environment
  • get_logs - Get logs from a service

Volume Management (5 tools)

  • get_volumes - List volumes in an environment
  • reset_volume - Reset volume to initial state
  • get_snapshots - List volume snapshots
  • create_snapshot - Create volume snapshot
  • load_snapshot - Load volume snapshot

Organization Management (3 tools)

  • get_orgs - List all organizations
  • get_org - Get current default organization
  • set_org - Set default organization

Limited Tools

These tools return help text directing users to use CLI commands instead:

  • exec_service - Execute commands in service containers
  • port_forward - Port forward services to local machine
  • telepresence_connect - Connect to telepresence