Liveblocks MCP Server

What is Liveblocks MCP Server about?

Liveblocks MCP Server exposes a set of functions from the Liveblocks REST API to AI models, allowing them to programmatically manage collaborative resources such as rooms, threads, comments, notifications, and to read real‑time storage and Yjs documents.

How to use Liveblocks MCP Server?

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

   npx -y @liveblocks/liveblocks-mcp-server
   

3. Run the server with the secret key set in the environment:

   LIVEBLOCKS_SECRET_KEY=sk_... npx -y @liveblocks/liveblocks-mcp-server
   

4. Configure your AI client (Cursor, Claude Desktop, VS Code, etc.) to point to the running MCP server according to the client’s documentation.

Key Features of Liveblocks MCP Server

• Full CRUD operations on Liveblocks rooms, threads, comments, and notifications.
• Read‑only access to Liveblocks Storage and Yjs documents for real‑time data.
• Simple automatic setup via npx for various AI clients (Cursor, Claude Desktop, VS Code).
• Manual setup option with explicit Node.js execution and environment configuration.
• Integrated with Smithery platform for easy discovery and deployment.

Use Cases of Liveblocks MCP Server

• AI‑assisted collaboration tools: enable AI copilots to create or tidy up collaborative spaces on the fly.
• Automated moderation: let AI agents delete inappropriate comments or mute rooms automatically.
• Contextual assistance: AI can fetch the latest Yjs document state to provide real‑time suggestions.
• Notification automation: generate custom notifications based on activity patterns detected by AI.
• Custom workflow orchestration: combine AI reasoning with Liveblocks resources to build specialized collaborative workflows.

FAQ from the Liveblocks MCP Server

Q: Which environment variable holds the API key? A: LIVEBLOCKS_SECRET_KEY.

Q: Do I need to build the project manually? A: No, the npx command runs the pre‑built package directly. Manual build (npm install && npm run build) is only required for custom development.

Q: Can I use the server with any AI client? A: Yes, as long as the client supports MCP configuration. Instructions for Cursor, Claude Desktop, and VS Code are provided, and other clients can be set up similarly.

Q: Is the server compatible with both development and production environments? A: Yes. Use the appropriate Liveblocks secret key (development or production) in the LIVEBLOCKS_SECRET_KEY variable.

Q: Where can I find more documentation? A: Visit the Liveblocks docs at https://liveblocks.io/docs/tools/mcp-server.

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..."
      }
    }
  }
}