Liveblocks MCP Server

1<p align="center">
2  <a href="https://liveblocks.io#gh-light-mode-only">
3    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" />
4  </a>
5  <a href="https://liveblocks.io#gh-dark-mode-only">
6    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" />
7  </a>
8</p>
9 
10# `liveblocks-mcp-server`
11 
12[![smithery badge](https://smithery.ai/badge/@liveblocks/liveblocks-mcp-server)](https://smithery.ai/server/@liveblocks/liveblocks-mcp-server)
13 
14This MCP server allows AI to use a number of functions from our [REST API](https://liveblocks.io/docs/api-reference/rest-api-endpoints). 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](https://liveblocks.io/docs/tools/mcp-server).
15 
16## Automatic setup
17 
18To install automatically, copy your Liveblocks secret key from a project in [your dashboard](https://liveblocks.io/dashboard) and run one of the following commands, replacing `[key]` with your secret key.
19 
20### Cursor
21 
22```bash
23npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client cursor --key [key]
24```
25 
26### Claude Desktop
27 
28```bash
29npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client claude --key [key]
30```
31 
32### VS Code
33 
34```bash
35npx -y @smithery/cli install @liveblocks/liveblocks-mcp-server --client vscode --key [key]
36```
37 
38### Other clients
39 
40Find installation information for other clients on [Smithery](https://smithery.ai/server/@liveblocks/liveblocks-mcp-server).
41 
42## Manual setup
43 
44<details><summary>Read more</summary>
45 
46<p></p>
47 
481. Clone this repo.
49 
50```bash
51git clone https://github.com/liveblocks/liveblocks-mcp-server.git
52```
53 
542. Build the project.
55 
56```bash
57npm install
58npm run build
59```
60 
613. Get your Liveblocks secret key from the [dashboard](https://liveblocks.io/dashboard).
62 
63```
64sk_dev_Ns35f5G...
65```
66 
67### Cursor
68 
694. Go to File → Cursor Settings → MCP → Add new server.
70 
715. Add the following, with the full path to the repo and your secret key:
72 
73```json
74{
75  "mcpServers": {
76    "liveblocks-mcp-server": {
77      "command": "node",
78      "args": ["/full/path/to/the/repo/liveblocks-mcp-server/build/index.js"],
79      "env": {
80        "LIVEBLOCKS_SECRET_KEY": "sk_dev_Ns35f5G..."
81      }
82    }
83  }
84}
85```
86 
876. Check it's enabled in the MCP menu.
88 
89### Claude Desktop
90 
914. Go to File → Settings → Developer → Edit Config.
92 
935. Open the JSON file, `claude_desktop_config.json`.
94 
956. Add the following, with the full path to the repo and your secret key:
96 
97```json
98{
99  "mcpServers": {
100    "liveblocks-mcp-server": {
101      "command": "node",
102      "args": ["/full/path/to/the/repo/liveblocks-mcp-server/build/index.js"],
103      "env": {
104        "LIVEBLOCKS_SECRET_KEY": "sk_dev_Ns35f5G..."
105      }
106    }
107  }
108}
109```
110 
111</details>
112