Liveblocks MCP Server

What is Liveblocks MCP Server about?

The server acts as a bridge that lets AI models perform actions on the Liveblocks platform via its REST API. It supports full CRUD operations on core Liveblocks entities such as rooms, threads, comments, and notifications, and also grants read access to the underlying Storage and Yjs CRDT layer.

How to use Liveblocks MCP Server?

1. Obtain a Liveblocks secret key from your dashboard.
2. Install the server (automatic):

   npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client <client> --key <YOUR_SECRET_KEY>
   

   Replace <client> with cursor, claude, vscode, etc.
3. For manual setup:
   • Clone the repo, run npm install and npm run build.
   • Launch the built entry point with the secret key in the environment, e.g.:

     LIVEBLOCKS_SECRET_KEY=sk_... node build/index.js
     

4. Register the server in the MCP configuration of your AI client (Cursor, Claude Desktop, VS Code) by pointing to the executable command.

Key features of Liveblocks MCP Server

• Direct access to Liveblocks REST API for rooms, threads, comments, notifications.
• Read‑only access to Storage and Yjs CRDT data.
• Works with major AI clients (Cursor, Claude Desktop, VS Code) via Smithery CLI.
• Fully typed TypeScript codebase, easy to extend.
• Supports real‑time collaboration workflows.

Use cases of Liveblocks MCP Server

• Building AI‑driven assistants that can create and manage collaborative spaces on‑the‑fly.
• Automated moderation bots that add, edit, or delete comments and threads.
• Notification generation bots that trigger alerts based on collaborative events.
• Data extraction tools that read Storage/Yjs states for analysis or reporting.

FAQ from the Liveblocks MCP Server

Q: Which environment variable holds the API key? A: LIVEBLOCKS_SECRET_KEY must contain your Liveblocks secret key.

Q: Do I need to build the project before running it? A: Yes, run npm install and npm run build if you use the manual setup.

Q: Can I use the server with other AI clients besides the listed ones? A: Yes, as long as the client supports MCP servers—you only need to add the server configuration.

Q: Is there any cost associated with using the server? A: The server itself is open‑source; you only pay for the Liveblocks usage according to your plan.

Q: How do I update the server to a newer version? A: Re‑run the npx @smithery/cli install … command or pull the latest repository and rebuild.

liveblocks-mcp-server

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.

Automatic setup

To install automatically, copy your Liveblocks secret key from a project in your dashboard and run one of the following commands, replacing [key] with your secret key.

Cursor

npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client cursor --key [key]

Claude Desktop

npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client claude --key [key]

VS Code

npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client vscode --key [key]

Other clients

Find installation information for other clients on Smithery.

Manual setup

1. Clone this repo.

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

2. Build the project.

npm install
npm run build

3. Get your Liveblocks secret key from the dashboard.

sk_dev_Ns35f5G...

Cursor

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

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

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

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

Claude Desktop

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

5. Open the JSON file, claude_desktop_config.json.

6. Add the following, with the full path to the repo and your secret key:

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