https://github.com/liveblocks/liveblocks-plugin
https://github.com/liveblocks/liveblocks-plugin
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/liveblocks/liveblocks-plugin
- Owner: liveblocks
- License: apache-2.0
- Created: 2026-06-18T08:45:13.000Z (9 days ago)
- Default Branch: main
- Last Pushed: 2026-06-18T10:29:23.000Z (9 days ago)
- Last Synced: 2026-06-18T12:23:36.778Z (8 days ago)
- Size: 133 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Liveblocks plugin
The Liveblocks plugin helps AI coding assistants write Liveblocks and Yjs code.
It bundles agent skills, MCP server configuration, and instruction files for
AI coding tools.
## Install
Install the Liveblocks plugin:
```bash
npx plugins add liveblocks/liveblocks-plugin
```
After installation, start a new thread in your AI coding tool so the Liveblocks
skills and MCP server are available.
## Supported tools
| Tool | Status |
| ------------------------------------------------------------- | --------- |
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | Supported |
| [OpenAI Codex](https://openai.com/codex) | Supported |
| [Cursor](https://www.cursor.com/) | Supported |
| [Grok Build](https://x.ai/news/grok-build-cli) | Supported |
| [GitHub Copilot](https://github.com/features/copilot) | Supported |
The `plugins` CLI currently installs the plugin automatically for Claude Code,
Cursor, and OpenAI Codex. Grok Build and GitHub Copilot can use the repository's
plugin manifest, skills, MCP configuration, and instruction files directly.
## Available skills
| Skill | Description | Source |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| [`liveblocks-best-practices`](./skills/liveblocks-best-practices) | Best practices for Liveblocks rooms, auth, presence, Storage, comments, notifications, text editors, React patterns, and more. | Authored here |
| [`yjs-best-practices`](./skills/yjs-best-practices) | Guidance for Yjs data modeling, updates, performance, subdocuments, providers, and common debugging issues. | Authored here |
## MCP server
The plugin includes the
[Liveblocks MCP server](https://github.com/liveblocks/liveblocks-mcp-server),
giving agents tool access to 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.
Set a development project secret key before starting your coding agent:
```bash
export LIVEBLOCKS_SECRET_KEY="sk_..."
```
Do not use a production secret key. The MCP server gives your agent direct
access to inspect and modify data in that Liveblocks project.
## When to use
After installation, skills are automatically available in your AI tool. Your
agent will use them when it judges they are relevant.
### Examples
```
How do I handle unstable Wi-Fi connections with Liveblocks?
```
```
How do I pass custom headers to my auth endpoint?
```
```
Why is my Y.Map growing so large?
```
## Source code
The plugin package is available in
[`liveblocks/liveblocks-plugin`](https://github.com/liveblocks/liveblocks-plugin).
Standalone skills are available in
[`liveblocks/skills`](https://github.com/liveblocks/skills).