This MCP server allows AI to use a number of functions from our REST API. For example, it can create, modify, and delete different aspects of Liveblocks such as rooms, threads, comments, notifications, and more. It also has read access to Storage and Yjs. Learn more in our docs.
You'll need a secret key from a project in your dashboard. Replace sk_xxxxxxxxxxxx with it in the examples below, then connect in one of two ways:
- Hosted server – connect to
https://mcp.liveblocks.io/mcp. Nothing to install. - Local server – run on your machine with
npx.
Add https://mcp.liveblocks.io/mcp to your client, passing your secret key as a bearer token in the Authorization header.
Read more
- Go to File → Cursor Settings → MCP → Add new server.
- Add the following, inserting your secret key:
{
"mcpServers": {
"liveblocks": {
"url": "https://mcp.liveblocks.io/mcp",
"headers": {
"Authorization": "Bearer sk_xxxxxxxxxxxx"
}
}
}
}Read more
Run the following command in the terminal, inserting your secret key:
claude mcp add --transport http liveblocks https://mcp.liveblocks.io/mcp \
--header "Authorization: Bearer sk_xxxxxxxxxxxx"Read more
Claude Desktop can't send custom headers to remote servers yet, so connect through mcp-remote:
-
Go to Settings → Developer → Edit Config.
-
Open the JSON file,
claude_desktop_config.json. -
Add the following to the JSON, inserting your secret key:
{
"mcpServers": {
"liveblocks": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://mcp.liveblocks.io/mcp",
"--header",
"Authorization: Bearer sk_xxxxxxxxxxxx"
]
}
}
}- Restart Claude Desktop to apply the changes.
Read more
Add the following to ~/.codex/config.toml, and export LIVEBLOCKS_SECRET_KEY in your shell:
[mcp_servers.liveblocks]
url = "https://mcp.liveblocks.io/mcp"
bearer_token_env_var = "LIVEBLOCKS_SECRET_KEY"Install by running one of the following commands, replacing sk_xxxxxxxxxxxx with your secret key.
Read more
- Go to File → Cursor Settings → MCP → Add new server.
- Add the following, inserting your secret key:
{
"mcpServers": {
"liveblocks": {
"command": "npx",
"args": ["-y", "github:liveblocks/liveblocks-mcp-server"],
"env": {
"LIVEBLOCKS_SECRET_KEY": "sk_xxxxxxxxxxxx"
}
}
}
}Read more
Run the following command in the terminal, inserting your secret key:
claude mcp add liveblocks -e LIVEBLOCKS_SECRET_KEY=sk_xxxxxxxxxxxx -- npx -y github:liveblocks/liveblocks-mcp-serverRead more
-
Go to Settings → Developer → Edit Config.
-
Open the JSON file,
claude_desktop_config.json. -
Add the following to the JSON, inserting your secret key:
{
"mcpServers": {
"liveblocks": {
"command": "npx",
"args": ["-y", "github:liveblocks/liveblocks-mcp-server"],
"env": {
"LIVEBLOCKS_SECRET_KEY": "sk_xxxxxxxxxxxx"
}
}
}
}- Restart Claude Desktop to apply the changes.
Read more
- Ensure the Codex CLI is installed:
npm i -g @openai/codex- Run the following command in the terminal, inserting your secret key:
codex mcp add liveblocks \
--env LIVEBLOCKS_SECRET_KEY=sk_xxxxxxxxxxxx \
-- npx -y github:liveblocks/liveblocks-mcp-server