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

# Workspace MCP

> Deploy and operate Beam through an MCP client

Connect your coding agent to Beam to deploy projects and manage your workspace:

```bash theme={null}
beam login
beam setup agent
beam mcp status
```

Restart your agent after setup. The local server runs with `beam mcp` and uses your selected CLI context. See [agent setup](/v2/getting-started/add-to-cursor-claude) for client options.

## Local Tools

| Tool | Purpose |
| - | - |
| `login`, `login_status` | Start browser authentication and check its progress |
| `deploy` | Build and deploy a local directory, Python handler, Dockerfile, or container image |
| `deploy_status` | Follow a deployment started by the local tool |

Give the agent your project's absolute path. Python projects also need the [SDK installed locally](/v2/getting-started/installation#python-sdk-and-cli).

## Workspace Tools

| Area | Tools |
| - | - |
| Identity | `whoami` |
| Apps | `list_apps`, `get_app`, `delete_app` |
| Versions | `list_deployments`, `get_deployment`, `redeploy`, `start_deployment`, `stop_deployment`, `delete_deployment`, `scale_deployment`, `invoke` |
| Configuration | `update_config`, `set_env`, `connect_services` |
| Secrets | `list_secrets`, `create_secret`, `update_secret`, `delete_secret` |
| Databases | `list_databases`, `create_database`, `database_credentials`, `rotate_database_credentials`, `delete_database` |
| Volumes | `list_volumes`, `create_volume` |
| Stacks | `list_stacks`, `create_stack`, `update_stack`, `delete_stack` |
| Observability | `logs`, `list_tasks`, `get_task`, `stop_task`, `metrics`, `request_stats` |
| Event subscriptions | `list_webhooks`, `create_webhook` |
| Other REST operations | `api_routes`, `api` |

`whoami` shows the current workspace and its credit status.

Use `name` for the newest active deployment or `deployment_id` for a specific version. See [deployment lifecycle](/v2/hosting/deployments) for restarts and rollbacks.

`update_config` accepts paths such as `runtime.cpu`, `runtime.memory`, and `autoscaler.min_containers`. CPU is in **millicores** (1000 = 1 CPU); memory is in MB. Use `set_env` or `connect_services` for [environment references](/v2/hosting/references).

<Note>
  Configuration changes deploy a new version. Secret updates take effect on the next container start. Database credential rotation restarts the database and connected apps.
</Note>

## Confirmation and Scope

App, deployment, secret, and database deletion require `confirm: true`, as do non-GET calls through `api`.

Use `api_routes` to list routes and `api` to call them. `{ws}` expands to your workspace ID. Workspace permissions apply.

## Remote Clients

Use `https://app.beam.cloud/api/v1/mcp` with `Authorization: Bearer <token>` in your client configuration. It accepts JSON-RPC POST requests, without a GET event stream. Local projects require `beam mcp`.

For documentation search, use `https://docs.beam.cloud/mcp`.