liveblocks-mcp-server

The liveblocks-mcp-server enables AI to utilize various functions through the Liveblocks REST API. It allows for the creation, modification, and deletion of elements such as rooms, threads, comments, and notifications, and provides read access to Storage and Yjs. Its automatic setup feature facilitates easy installation.

GitHub Stars

11

User Rating

Not Rated

Favorites

0

Views

7

Forks

7

Issues

4

README

Liveblocks Liveblocks

liveblocks-mcp-server

smithery badge

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
Read more

  1. Clone this repo.
git clone https://github.com/liveblocks/liveblocks-mcp-server.git
  1. Build the project.
npm install
npm run build
  1. Get your Liveblocks secret key from the dashboard.
sk_dev_Ns35f5G...
Cursor
  1. Go to File → Cursor Settings → MCP → Add new server.

  2. 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..."
      }
    }
  }
}
  1. Check it's enabled in the MCP menu.
Claude Desktop
  1. Go to File → Settings → Developer → Edit Config.

  2. Open the JSON file, claude_desktop_config.json.

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