Set Up Coding Agents

Connect Cursor, Claude, Codex, or Windsurf to your Beam workspace and docs

Connect your coding agent to Beam to deploy apps, create databases, and read logs.

Install the Workspace Tools

uv tool install beam-client
beam setup agent
beam login

beam setup agent detects Cursor, Claude Code, Codex, Windsurf, and Claude Desktop. It installs the Beam skill and MCP server. Restart your agent afterward.

Select clients explicitly when needed:

beam setup agent --client cursor --client claude-code
beam mcp status

Use --skip-skills or --skip-mcp to install just one. If setup reports a client config error, fix that file and rerun setup.

Sign in Through Your Agent

Your agent can sign you in with the login and login_status tools. Open the verification link it provides, then approve access in your browser.

Try: “Deploy this project to Beam.” See the MCP reference for more tools.

Manual MCP Registration

The local server runs over stdio:

beam mcp

Print the configuration for your client without changing its files:

beam mcp install --client cursor --print

Add --project for project-level Cursor or Claude Code configuration. Use --context production to select a named context.

Search the Docs with MCP

The hosted documentation server is:

https://docs.beam.cloud/mcp

For clients that accept URL-based configuration:

{
  "mcpServers": {
    "beam-docs": {
      "url": "https://docs.beam.cloud/mcp"
    }
  }
}

This server only searches documentation. See docs for AI tools for Markdown pages and llms.txt.