Skip to main content

​
Before you start

​
Setup with sign-in

Run this once in your terminal:
Start Claude Code, run /mcp, pick revyops and choose Authenticate. RevyOps opens in your browser. Log in if asked, then choose the workspaces Claude can see (all of them, or only the ones you tick) and its access: Read only to look things up, or Read & write to also make changes. A note at the bottom sums up what Claude will be able to do. Click Approve. Agency admins can sign in for any workspace in the agency, and Workspace admins for their own workspace. Members connect with an API key. For an Agency admin with read and write access to all workspaces, the approval screen also offers Agency custom fields, off unless you tick it. With it ticked, Claude can list your agency’s master schema, add a workspace’s field to it, and change a master field’s type and dropdown options through the agency custom fields tools. Each change reaches every workspace at once. Without the tick, or with an API key, Claude can’t change a master field, and create_custom_field refuses one with a 409. The same screen offers Agency workflows, also off unless you tick it. With it ticked, Claude can change the steps, name and trigger of a workflow the agency shares with several workspaces, and publish the change to every live workspace in it. A step’s settings stay each workspace’s own, so Claude sets them workspace by workspace. Without the tick, or with an API key, Claude only changes a shared workflow’s values for one workspace and turns it on or off there. Deleting a shared workflow stays in the builder. To change the workspaces, the access, Agency custom fields or Agency workflows later, or to disconnect Claude, go to Developer → Connected AI agents. After turning Agency custom fields on there, reconnect from /mcp so Claude picks up the new tools.

​
Setup with an API key

Run this once in your terminal:
Replace RO-your-key-here with your API key.

​
Check the connection

Start Claude Code:
Then ask:
Claude should reply with the workspaces your key can access. You can also run /mcp inside Claude Code to see whether the revyops server is connected.

​
Managing multiple workspaces

Each workspace has its own API key. Comma-separate the keys to use several in one session:
Ask Claude to “list my workspaces” to see which workspaces it can reach. If fewer workspaces come back than keys you pasted, RevyOps didn’t recognize one of them, most often because it’s a master key or was copied wrong. Then refer to a workspace by name, since a question that names no workspace goes to the first key’s workspace:

​
Sharing with your team

To add RevyOps to one project only, and share the setup with everyone working on it, create a .mcp.json file in the project root:
Each person sets REVYOPS_API_KEY in their own environment, so no key is committed to the repository.

​
Troubleshooting

Double-check your API key is copied correctly with no extra spaces. Run /mcp to see the server’s status.
Ask Claude to “list my workspaces” first, which confirms which workspaces your key has access to.
Go to Developer → Keys → Generate key. Workspace keys start with RV- (read-write) or RO- (read-only), and only these work with the MCP server. An agency master key, starting with ML-, is skipped without an error.