CLI Command
beam mcp
Start Beam's MCP server over stdio so coding agents can call Beam tools.
beam mcp is normally launched by an MCP-compatible coding agent after beam init writes or prints the client configuration.
The server runs over stdio and exposes tools such as get_design_context, get_node_image, list_assets, download_assets, get_file_variables, and compare capability when available.
MCP tools must call the same Beam Core APIs as the CLI. This keeps human commands and agent tools aligned for Figma fetches, cache behavior, snapshots, assets, evidence, and errors.
Tool responses should be compact, structured, credential-safe, and actionable. If data is missing, rate-limited, or inaccessible, Beam should return warnings and clarification requests rather than guessing silently.
1beam mcpRun Sequence
- Run
beam init --printand confirm the MCP config points tobeam mcp. - Start the agent or run
beam mcpmanually for transport verification. - Give the agent a Figma frame URL and ask it to use Beam.
- Let the agent request context, images, assets, and compare results through MCP tools.
Expected Output
When launched by an agent, Beam should expose its MCP tool list and return JSON-safe responses with paths, warnings, confidence, and build readiness. Manual startup should remain quiet unless the transport reports an error.
Files And Artifacts
- No project file is required unless tools create cache, assets, snapshots, or compare artifacts
Next Step
Ask the coding agent to build from a frame and compare the result against Figma.
Recovery Paths
- If the agent cannot start the server, confirm
beamis on PATH for the agent process. - If tools return auth errors, run
beam loginin the same user account. - If tool output is too large, request a smaller context mode or use cached snapshots.
