Liveblocks MCP

This MCP server lets AI access and manage specific Liveblocks REST API capabilities, such as creating, updating, and removing rooms, threads, comments, notifications, and more, while also reading data from Storage and Yjs. It enables automated, programmable control of Liveblocks features from an MCP client.

How to use

You integrate this MCP server with your MCP client to perform actions against Liveblocks programmatically. Start by obtaining a secret key from your Liveblocks dashboard, then configure one or more MCP server entries in your client to run locally or remotely. When you run a configured server, your client can perform create, read, update, and delete operations on Liveblocks resources, as well as read storage and Yjs data as permitted by the server.

How to install

Prerequisites: you need Node.js and npm installed on your machine. Ensure your environment has network access to install dependencies and run the server.

Step 1: Install the MCP server client tooling globally (or locally as appropriate for your setup) using npm. Then install the MCP server package to enable the MCP workflow.

Step 2: Run the build for the MCP server package if you are using a local clone. This prepares the executable index that the MCP client will invoke.

Step 3: Retrieve your Liveblocks secret key from the dashboard and prepare a secure way to pass it to the MCP process. You will export or provide this key to the running server configuration.

Step 4: In your MCP client, configure the MCP server entries to point at the local or remote server executable and supply the secret key. The configuration should look like the snippet below, with your actual full path and key.

Step 5: Enable the MCP server in your client’s MCP settings and verify it is active. You can then begin issuing MCP actions to create, modify, and delete Liveblocks resources, and to read Storage and Yjs data as allowed.

Configuration examples

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

Notes on security and keys

Keep your Liveblocks secret key secure. Treat it as a sensitive credential and restrict access to only trusted systems and users. Rotate keys if you suspect compromise and revoke old keys promptly.

Troubleshooting tips

If the MCP server does not start, verify that the node executable path is correct and that the build index exists at the specified location. Check that the secret key is correctly provided in the environment. Ensure your MCP client is configured to connect to the running server and that network/permissions allow the client to reach the server if running remotely.

Tools and capabilities

This MCP server exposes actions to manage core Liveblocks resources and access data streams. You can perform operations to create, modify, and delete rooms, threads, comments, and notifications, while also reading from Storage and Yjs to support informed decision making and data synchronization.

Available tools

create_room

Create a new Liveblocks room with specified properties.

update_room

Modify properties of an existing Liveblocks room.

delete_room

Remove a Liveblocks room.

create_thread

Create a new thread within a room.

delete_thread

Delete an existing thread.

add_comment

Add a comment to a thread.

delete_comment

Remove a comment from a thread.

send_notification

Send a notification to users or channels.

read_storage

Read data from Storage as needed by the client.

read_yjs

Read data from Yjs data structures for synchronization.