Skip to main content

​
Before you start

  • Git, and a runtime that loads skills, such as Claude Code or Codex.
  • Node.js 22.22.3 or newer.

​
Connect

Clone the SDK and run the standard Skills installer, which copies the skill into the agent’s skill folder:
Choose the agent and the scope when the installer asks, then confirm that relay appears in that agent’s installed skills. The source is skills/relay. The Relay CLI offers the same install as an optional step before setup, and you can decline it there. Mintlify provides documentation search for this site. It is read-only and does not access Relay Chats, Agents, or customer data. Your runtime may use it automatically through its installed skill; there is nothing to authenticate or paste into Relay. Installing a skill does not confirm or connect the optional Relay API MCP. Install that local server only when the runtime needs messaging tools. The Codex and Cursor plugins install the Relay skill. Install Relay API MCP separately only when the runtime needs to call messaging tools.

​
Send it a message

Ask your runtime to read the Relay skill and explain how to connect an existing agent. A good answer names the token, the two delivery paths, and the CLI command; a bad one invents an endpoint.

​
What it can do

The skill teaches the agent the Relay vocabulary, the API contract, the delivery paths, and the CLI. It does not create an agent, save a token, or read a chat; for that, connect the runtime on its own page.

​
When it fails

  • relay is not in the installed skills: run the installer again with the same agent and scope.

​
Next steps