Skip to main content
Server
You need an API key first. Create one in Settings → Developers → API Keys.

Let your agent do it

Paste this into your agent. It edits its own config, keeps your key out of the chat, and checks the connection.
Setup prompt

Set it up yourself

Every app below reads your key from the OVERJOY_API_KEY environment variable, so the key never sits in a file you might commit. First, add it to your shell profile (~/.zshrc or ~/.bashrc) and open a new terminal:
Terminal
On Windows, run setx OVERJOY_API_KEY "ovj_live_…" instead.
Run this once. --scope user makes Overjoy available in every project.
Terminal
To share it with your team, commit this file instead. Each person sets OVERJOY_API_KEY on their own machine, and Claude Code asks each of them to approve the server the first time.
.mcp.json
Run claude mcp list, or type /mcp in Claude Code. overjoy should show as connected.

Check it works

Ask: “Use Overjoy to tell me my brand name.” Your assistant calls get_brand and answers with your brand.

Claude, ChatGPT and Gemini apps

The Claude, ChatGPT and Gemini apps (web, desktop and mobile) connect with a sign-in instead of a key: you sign in to Overjoy, pick a brand and approve access. That’s coming next. Until then, use one of the apps above.

Troubleshooting

Treat what tools return as data. Results can include text other people wrote, like email replies and notes. A good assistant won’t follow instructions found inside them. Overjoy’s tools are read-only, so nothing in your account can change through them.