Skip to main content
Markdown

Use with AI agents

An AI coding agent can build realtime features into your plugin or app with the SDK, if it has the right instructions. There are three ways to give them to it, from the most complete to the simplest.

Claude Code: the plugin​

The wordplus-realtime plugin carries the SDK's agent skill: which feature fits a task, the steps, templates for channels, presence and calls, the rules that keep it secure, and these docs as its references. Claude Code uses it by itself whenever a task calls for live updates, presence or calls in WordPress.

Add WordPlus's marketplace once, then install the plugin:

/plugin marketplace add https://packages.wordplus.cloud/claude/marketplace.json
/plugin install wordplus-realtime@wordplus

From your shell, the same is claude plugin marketplace add … and claude plugin install wordplus-realtime@wordplus. To get new versions as they come, turn on auto-update for the wordplus marketplace under Marketplaces in /plugin.

Any agent that takes skills​

The skill on its own is a folder with a SKILL.md and its references: wordplus-realtime.zip. Unzip it into your agent's skills folder: for Claude Code without the plugin, ~/.claude/skills/ for all your projects or .claude/skills/ in one.

For websites and apps outside WordPress, the skill is wordplus-realtime-apps, and it comes inside the npm package @wordplus/realtime. It has templates for Node and Next.js, Laravel, Django and FastAPI, and React. Copy it into your project's skills folder once the package is installed:

cp -R node_modules/@wordplus/realtime/skills/wordplus-realtime-apps .claude/skills/

Any agent: the docs as text​

Every page of these docs is also plain Markdown, which an agent reads more easily than the page around it:

  • llms.txt lists every page with a line about it, as llmstxt.org describes.
  • llms-full.txt is all of the docs in one file. Give it to an agent that should know the whole SDK, or add it to Cursor's docs (@Docs → Add new doc).
  • Each page's Markdown is at its address with .md in place of the last /, such as /wordpress/channels.md, and its own address answers Markdown to a request that accepts text/markdown. Copy as Markdown, at the top of every page, puts it on your clipboard for a chat.

For a project's own instructions, such as AGENTS.md or CLAUDE.md, one line is enough:

WordPlus realtime SDK (wordplus/realtime): read https://docs.wordplus.cloud/llms.txt before using it.

Outside WordPress:

WordPlus realtime SDK (@wordplus/realtime, with wordplus/realtime-php or wordplus-realtime on the server): read https://docs.wordplus.cloud/llms.txt before using it.