Skip to content

liveblocks/liveblocks-plugin

Repository files navigation

Liveblocks Liveblocks

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:

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 Supported
OpenAI Codex Supported
Cursor Supported
Grok Build Supported
GitHub 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 Best practices for Liveblocks rooms, auth, presence, Storage, comments, notifications, text editors, React patterns, and more. Authored here
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, 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:

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.

Standalone skills are available in liveblocks/skills.

About

Realtime collaboration for your app. Adds Liveblocks and Yjs agent skills, MCP server configuration, and tool instructions for AI coding assistants.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors