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

# Deck MCP server

> Build, run, and debug Deck agents from any MCP client.

The Deck MCP server gives any [MCP](https://modelcontextprotocol.io) client access to your Deck organization. It can create sources and tasks, run tasks, answer interactions, and debug failed runs from their screenshots and browser logs.

```text theme={null}
https://mcp.deck.co/mcp
```

The server is hosted, so there's nothing to install. You sign in with your Deck account when you connect, and the server acts as you, with the permissions of your [role](https://docs.deck.co/guides/account/roles-and-permissions.md) in the Console.

> [!TIP]
>
> If you're using a coding agent, `npx @deckco/cli init` sets up the [Deck CLI](https://docs.deck.co/cli.md) and adds its [local MCP server](#run-it-locally) to your agent clients for you.

## Connect it

> [tab] Claude Code
>
> ```bash theme={null}
> claude mcp add --transport http deck https://mcp.deck.co/mcp
> ```
>
> Then run `/mcp`, select `deck`, and sign in.

> [tab] Claude
>
> 1. Open [Connectors](https://claude.ai/settings/connectors) in the Claude settings.
> 2. Click **Add custom connector**.
> 3. Name it `Deck` and enter `https://mcp.deck.co/mcp` as the URL.
> 4. Click **Add**, then **Connect**, and sign in.

> [tab] ChatGPT
>
> 1. In ChatGPT, open **Settings**, then **Apps**.
> 2. Under **Advanced settings**, turn on **Developer mode**.
> 3. Click **Create app**. Name it `Deck`, enter `https://mcp.deck.co/mcp` as the URL, and choose OAuth for authentication.
> 4. Click **Create** and sign in.

> [tab] Cursor
>
> 1. Open the command palette and search for **Open MCP settings**.
> 2. Click **Add custom MCP**. This opens `mcp.json`.
> 3. Add the server:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "deck": {
>       "url": "https://mcp.deck.co/mcp"
>     }
>   }
> }
> ```
>
> 4. Click **Connect** next to `deck` and sign in.

> [tab] Codex
>
> ```bash theme={null}
> codex mcp add deck --url https://mcp.deck.co/mcp
> codex mcp login deck
> ```

> [tab] Other clients
>
> Any client that supports the streamable HTTP transport and MCP authorization can connect to `https://mcp.deck.co/mcp`. The server publishes its OAuth metadata at `https://mcp.deck.co/.well-known/oauth-protected-resource/mcp`.

### Signing in

When you connect, your client opens the Deck sign-in page. Sign in, choose an organization if you belong to more than one, and approve access. Access is split into two scopes:

| Scope | Grants |
| - | - |
| `deck:read` | Tools that list and retrieve resources |
| `deck:write` | Tools that create, update, delete, and run, including `run_task`, plus `get_task_run_browser_logs` |

The server only offers the tools your granted scopes allow.

To switch organizations, reconnect the server in your client (in Claude Code, run `/mcp` and re-authenticate `deck`) and choose a different organization on the sign-in page. Reopening the connection without signing in again keeps the same organization.

## What it provides

The server registers the tools agents use most. Most other [API](https://docs.deck.co/api/using-the-api.md) operations your scopes allow are reachable through `execute`.

| Tool | What it does |
| - | - |
| `whoami` | Returns the organization the connection uses |
| `list_organizations` | Lists your organizations and marks the current one |
| `switch_organization` | Explains how to reconnect to use a different organization |
| `list_sources`, `create_source` | Lists and creates [sources](https://docs.deck.co/concepts/sources.md) |
| `list_tasks`, `get_task`, `create_task`, `update_task` | Manages [tasks](https://docs.deck.co/concepts/tasks.md) |
| `run_task` | Runs a task and waits, up to 45 seconds by default, for it to finish or need an interaction |
| `list_task_runs`, `get_task_run` | Lists and retrieves [task runs](https://docs.deck.co/concepts/task-runs.md) |
| `submit_interaction` | Answers an [interaction](https://docs.deck.co/guides/interactions.md) a run is waiting on |
| `get_task_run_screenshots`, `get_task_run_browser_logs` | Fetches a run's screenshots and browser logs for debugging |
| `create_credential_link`, `list_credentials` | Creates a credential through a hosted link, and lists credentials |
| `describe_operation` | Describes any operation's arguments before calling it through `execute` |
| `execute` | Runs any other operation by name, such as `delete_task` or `create_trigger` |
| `search_deck_docs`, `read_deck_docs_page` | Searches and reads these docs |
| `submit_product_feedback` | Reports a missing tool or unexpected behavior to the Deck team |

### Credentials

No tool accepts a password or other secret. To add a credential, the agent calls `create_credential_link` and gives you the URL. You, or whoever holds the login, enter the credential on a page hosted by Deck. The link expires within an hour. Nothing reports back when it's used, so the agent checks `list_credentials` for the new credential. See [Credentials](https://docs.deck.co/concepts/credentials.md).

### Runs and deletes

`run_task` starts a run against the live source.

Destructive operations, such as `delete_task` and `reset_task`, need `confirm: true` in the call. Without it, the server changes nothing and asks the agent to check with you first. Tools carry read-only and destructive annotations, so clients that ask before writes can prompt you.

### Sensitive tasks

For [sensitive tasks](https://docs.deck.co/concepts/tasks.md#sensitive-tasks), the server doesn't return screenshots or browser logs, matching the Console. Run status, output, and interactions are unaffected.

## Run it locally

The [Deck CLI](https://docs.deck.co/cli.md) includes a local version of the server for clients that run local MCP servers. It uses the CLI's credentials, from `deck login` or an API key, instead of signing in through the browser. It has the same task, source, and run tools, but not `create_credential_link`, `list_organizations`, or `switch_organization`. Use the hosted server to collect credentials, or run [`deck credentials create --link`](https://docs.deck.co/cli#add-credentials) in a terminal.

```bash theme={null}
deck mcp install
```

`deck mcp install` adds the server to Claude Code, Claude Desktop, Cursor, and Windsurf, and prints the entry to paste for Codex and VS Code. `--client <id>` picks the clients. To add it by hand, have your client run `npx -y @deckco/cli mcp serve`. For example, in Claude Code:

```bash theme={null}
claude mcp add deck -- npx -y @deckco/cli mcp serve
```

| Flag | Effect |
| - | - |
| `--read-only` | Removes every write, including through `execute` |
| `--tools <list>` | Registers only the named tools |
| `--all-tools` | Registers every operation as its own tool instead of using `execute` |

`deck mcp install --read-only` writes `--read-only` into each client's config. To use `--tools` or `--all-tools`, add them to the client's command by hand.

## Docs-only server

To search the docs without a Deck account, connect the docs server instead. It's read-only and can't see your organization.

```text theme={null}
https://docs.deck.co/mcp
```

Connect it the same way as the Deck server, with `deck-docs` as the name and no sign-in. You can also add it from any docs page: open the context menu at the top of the page to copy the URL or add it to Cursor or VS Code.

| Tool | What it does |
| - | - |
| `search_deck_docs` | Searches the docs and returns matching pages with titles and links |
| `query_docs_filesystem_deck_docs` | Reads full pages as Markdown |
| `submit_feedback` | Reports incorrect, outdated, or confusing documentation |

The docs server also exposes the [Deck skill](https://docs.deck.co/ai.md) as an MCP resource.

For a skill, a prompt, and raw docs files for coding agents, see [LLM context](https://docs.deck.co/ai.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.