Skip to content
Docs / Quickstart

Quickstart

Astron is an MCP server. Add it to your coding agent once, and the agent can ask for design guides, references, palettes and type scales while it builds. This page takes you from nothing to a first tool call.

Before you start

  • An MCP-capable agent: Claude Code, Codex, Cursor, Windsurf, Zed or VS Code with MCP enabled.
  • Node 18 or later, only if your client runs servers over stdio (Codex, most editors).
  • An API key is optional. The free library works without one; a key unlocks Pro libraries and per-project usage on the dashboard.

1. Add the server

Pick your client. Claude Code connects to the hosted endpoint directly; clients that only speak stdio run the @astron/mcp bridge, which forwards to the same endpoint.

$ claude mcp add astron https://mcp.astron.design --transport http

Windsurf, Zed and other clients have their own config files. See Cursor and Other MCP clients.

2. Check the connection

List your servers. Astron should report six tools.

Terminal
$ claude mcp list
astron  https://mcp.astron.design (HTTP)  ✓ connected  6 tools

3. Make your first call

Ask for a screen and mention Astron once. Most agents keep calling it on their own after that, because the tool descriptions tell them when a guide applies.

Prompt
Use Astron to design the billing settings page. Follow the guide it returns.

You will see a get_design_guide call first, usually followed by search_references. Each call shows up in Tool calls within a few seconds.

4. Add a key (optional)

Create a key on the dashboard and export it as ASTRON_KEY. Keys start with ast_live_; keep them out of your repository.

Shell
export ASTRON_KEY=ast_live_…
Free workspaces get 300 tool calls a day. Pro and Team are unlimited within fair use. Details on Rate limits.