Tools - MCP server

The Liveblocks MCP server allows you to inspect and modify your project with AI in compatible apps such as Cursor, VS Code, Claude Desktop, and more.

Features

Our MCP server features 39 different tools, enabling most features from our REST API. You can use it to:

• Create and modify rooms, threads, comments, notifications, more.
• Read realtime Storage and Yjs values.
• Broadcast custom events to connected clients.
• Mark threads and notifications as read/unread.

AI will often string tool calls together—for example, if you ask it to fetch a room that doesn’t exist, it will ask if you’d like to create the room first, and then fetch it after.

Automatic setup

To install automatically, use one of the following commands, making sure to insert a secret key from your correct project in your dashboard.

Cursor

Run the following command to set up Cursor:

$npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client cursor --key "sk_prod_xxxx…xxxxxxsk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"

Claude

Run the following command to set up Claude Desktop:

$npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client claude --key "sk_prod_xxxx…xxxxxxsk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"

VS Code

Run the following command to set up VS Code:

$npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client vscode --key "sk_prod_xxxx…xxxxxxsk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"

Other clients

Find installation information for other clients on Smithery.

Manual setup

1. Clone the Liveblocks MCP server repo.

$git clone https://github.com/liveblocks/liveblocks-mcp-server.git

2. Build the project.

$npm installnpm run build

Cursor

3. Go to File → Cursor Settings → MCP → Add new server.

4. Add the following, with the full path to the repo and the correct secret key from your dashboard:

{  "mcpServers": {    "liveblocks-mcp-server": {      "command": "node",      "args": ["/full/path/to/the/repo/liveblocks-mcp-server/build/index.js"],      "env": {        "LIVEBLOCKS_SECRET_KEY": "sk_prod_xxxx…xxxxxxsk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"      }    }  }}

5. Check it's enabled in the MCP menu.

Claude Desktop

3. Go to File → Settings → Developer → Edit Config.

4. Open the JSON file, claude_desktop_config.json.

5. Add the following, with the full path to the repo and the correct secret key from your dashboard:

{  "mcpServers": {    "liveblocks-mcp-server": {      "command": "node",      "args": ["/full/path/to/the/repo/liveblocks-mcp-server/build/index.js"],      "env": {        "LIVEBLOCKS_SECRET_KEY": "sk_prod_xxxx…xxxxxxsk_prod_xxxxxxxxxxxxxxxxxxxxxxxx"      }    }  }}

Source code

The source code is available in our GitHub repository.