> ## Documentation Index
> Fetch the complete documentation index at: https://autodock.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP

> Control Autodock environments from your favorite AI agent

Autodock allows you to spawn, connect to, and manage remote development servers by talking to your
favorite agents using MCP.

<Tip>
  **Mike's tip:** When I use Autodock at [Rightware](https://rightware.com), I start a server using
  MCP and leave it up during the day so that folks can test out features end-to-end as I hack on
  them in real time.
</Tip>

## Quickstart

Add the Autodock MCP server to your favorite AI tool:

<Tabs>
  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add --transport http autodock https://autodock.io/api/mcp/streamable-http
    ```
  </Tab>

  <Tab title="Cursor">
    Click to install directly:

    <a href="https://cursor.com/en-US/install-mcp?name=autodock&config=eyJ1cmwiOiJodHRwczovL2F1dG9kb2NrLmlvL2FwaS9tY3Avc3RyZWFtYWJsZS1odHRwIn0%3D">
      **→ Add to Cursor**
    </a>

    Or add manually to your Cursor MCP settings:

    ```json theme={null}
    {
      "mcpServers": {
        "autodock": {
          "url": "https://autodock.io/api/mcp/streamable-http"
        }
      }
    }
    ```
  </Tab>

  <Tab title="VS Code">
    <a href="https://vscode.dev/redirect/mcp/install?name=autodock&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fautodock.io%2Fapi%2Fmcp%2Fstreamable-http%22%7D" target="_blank">
      **→ Add to VS Code**
    </a>

    Or add manually to your VS Code MCP settings:

    ```json theme={null}
    {
      "mcpServers": {
        "autodock": {
          "type": "http",
          "url": "https://autodock.io/api/mcp/streamable-http"
        }
      }
    }
    ```
  </Tab>

  <Tab title="Codex">
    ```bash theme={null}
    codex mcp add autodock --url https://autodock.io/api/mcp/streamable-http
    ```
  </Tab>

  <Tab title="Other">
    Add this URL as an HTTP MCP server in your AI tool:

    ```
    https://autodock.io/api/mcp/streamable-http
    ```
  </Tab>
</Tabs>

<Tip>
  **Mike's tip:** This always trips me up. Once in your agent, you usually need to type `/mcp`, find
  Autodock, and authorize it. After that, it's smooth sailing.
</Tip>

After installing Autodock, try the following commands with your agent:

1. Please spin up an autodock box.
2. Sync my work.
3. Run everything.
4. Expose ports.

That should get you up and running! For more advanced use cases, see the reference below.

## Tool Reference

### Environment Lifecycle

| Tool          | Description                                                 |
| ------------- | ----------------------------------------------------------- |
| `env.launch`  | Launch a new environment. Returns SSH credentials and URLs. |
| `env.list`    | List all your environments with their status.               |
| `env.status`  | Get detailed status for a specific environment.             |
| `env.stop`    | Stop a running environment (can be resumed later).          |
| `env.destroy` | Permanently destroy an environment.                         |

### File & Command Operations

| Tool       | Description                                        |
| ---------- | -------------------------------------------------- |
| `env.sync` | Get SSH credentials for syncing files (rsync/scp). |
| `env.run`  | Get SSH command to execute commands remotely.      |

### Port Exposure

| Tool              | Description                                |
| ----------------- | ------------------------------------------ |
| `env.expose`      | Expose a port with a public HTTPS URL.     |
| `env.unexpose`    | Remove an exposed port.                    |
| `env.listExposed` | List all exposed ports for an environment. |

### Reserved Instances

Reserved instances run 24/7 without auto-stopping and don't count against your concurrent
environment limit. A reserved instance costs \$149 and lasts for 30 days. Requires a paid plan
(Starter or Pro).

| Tool                  | Description                                                                             |
| --------------------- | --------------------------------------------------------------------------------------- |
| `env.reserve`         | Preview reservation cost for an environment. Shows price, duration, and current status. |
| `env.reserve_confirm` | Confirm and pay for reservation. Charges your card and reserves for 30 days.            |

### Inbound Email

Receive emails at `*@{slug}.autodock.io` for testing auth flows, notifications, and more.

| Tool        | Description                                            |
| ----------- | ------------------------------------------------------ |
| `env.email` | Get your environment's email domain and webhook setup. |

### GitHub Actions Runner

Autodock environments include a pre-installed GitHub Actions runner at `/opt/actions-runner`.

| Tool            | Description                                                  |
| --------------- | ------------------------------------------------------------ |
| `env.gh_runner` | Get commands to configure and start a GitHub Actions runner. |

<Note>
  The runner is configured in **ephemeral mode** - it processes one job and then exits. Labels
  `autodock` and your environment slug are automatically added.
</Note>

### Account & API Keys

| Tool                     | Description                                                                    |
| ------------------------ | ------------------------------------------------------------------------------ |
| `account.info`           | Get your plan, usage, quota status, and upgrade URL. Includes hours remaining. |
| `account.create_api_key` | Create an API key for headless MCP authentication.                             |
| `account.list_api_keys`  | List your API keys (shows prefix only, not full key).                          |
| `account.revoke_api_key` | Revoke an API key by ID.                                                       |