IDE Integration
Connect Elixium to your AI coding assistant. Access your backlog, update stories, and get AI guidance without leaving your IDE.
🔌 One Integration, Every AI Agent
Elixium uses the Model Context Protocol (MCP) — the universal standard adopted by GitHub Copilot, Claude, Cursor, Gemini, and more. Configure once, use everywhere.
🏪 VS Code: One-Click Install
Elixium is available in the VS Code MCP Server Gallery — the same place you find GitHub, Notion, Playwright, and other MCP servers. This is the easiest way to get started with GitHub Copilot or any VS Code AI agent.
Option A: Install from VS Code
- Open the Command Palette (
Ctrl+Shift+P/Cmd+Shift+P) - Type "MCP: Add Server" and select it
- Search for "elixium" in the gallery
- Click Install — VS Code will prompt you to enter the required environment variables (see below)
Option B: Install from the Web
- Visit the GitHub MCP Registry
- Search for "elixium"
- Click "Install in VS Code" — it opens VS Code with a pre-filled config and prompts for your variables
You'll be prompted for:
ELIXIUM_API_KEY— Your API key from Command Center > Settings > API KeysELIXIUM_API_URL— Your workspace URL, e.g.https://your-team.elixium.ai/apiELIXIUM_BOARD_SLUG— (optional) The board to connect to, defaults to auto-detectELIXIUM_USER_EMAIL— (optional) Your email for story attribution
Why use the gallery? No npx, no JSON editing, no stdout issues. VS Code handles installation and lifecycle management for you. Updates are picked up automatically when new versions are published.
⚡ Quick Start — Manual Config (5 Minutes)
For IDEs without a gallery (Cursor, Claude Code, Codex, etc.) or if you prefer manual setup:
- Get your API Key — Go to your Elixium workspace settings and generate an API key.
- Find your Board Slug — Copy the slug from your board URL (e.g.,
my-projectfromelixium.ai/tenant/myteam/board/my-project). - Configure your AI Agent — Add the MCP config to your IDE (see below).
- Verify — Ask your AI: "What stories are in Current?"
📦 Prerequisites
The Elixium MCP server runs via npx (included with Node.js). No separate installation is required — it downloads automatically on first use.
Required: Node.js 18+
# Check if Node.js is installed
node --version
# If not installed, get it from nodejs.org or use:
brew install node # macOS
Optional: Pre-install the MCP Server
While npx auto-downloads on first run, you can pre-install globally for faster startup:
npm install -g @elixium.ai/mcp-server
If globally installed, change "command": "npx" to "command": "elixium-mcp" in your config.
💡 Tip: The configs below use npx -y @elixium.ai/mcp-server@latest which always fetches the latest version. This is the recommended approach.
🤖 Configuration by AI Agent
🐙 GitHub Copilot (VS Code)
MCP support is GA as of VS Code 1.102 (July 2025). Copilot can now use Elixium tools natively.
Easiest: Use the VS Code MCP Gallery above — search "elixium" and one-click install. The manual config below is for advanced setups.
Manual setup — create .vscode/mcp.json in your project:
{
"servers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}Note: Copilot uses servers (not mcpServers).
✨ Gemini / Google Antigravity
Configure in your global or workspace MCP settings.
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}🎯 Cursor
Create .cursor/mcp.json in your project:
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}🟠 Claude Desktop
Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}🟣 Claude Code (VS Code Extension)
Claude Code runs as a VS Code extension with full MCP support. Add the config to your project or user settings.
Option 1: Project-level — create .claude/settings.local.json in your project:
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}Option 2: User-level — add to ~/.claude/settings.json to share across all projects:
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}💡 Tip: Use .claude/settings.local.json (not settings.json) for project-level config — the .local variant is gitignored by default, keeping your API key out of source control.
⌨️ OpenAI Codex CLI
Create .codex/mcp.json in your project:
{
"mcpServers": {
"elixium": {
"command": "npx",
"args": ["-y", "@elixium.ai/mcp-server@latest"],
"env": {
"ELIXIUM_API_KEY": "<YOUR_API_KEY>",
"ELIXIUM_API_URL": "https://<YOUR_TENANT>.elixium.ai/api",
"ELIXIUM_BOARD_SLUG": "main",
"ELIXIUM_USER_EMAIL": "<YOUR_EMAIL>"
}
}
}
}⚙️ Environment Variables
Configure the MCP server using these environment variables:
| Variable | Required | Description |
|---|---|---|
| ELIXIUM_API_KEY | Yes | Your workspace API key from Settings |
| ELIXIUM_API_URL | Yes | Your tenant API URL (e.g., https://acme.elixium.ai/api) |
| ELIXIUM_BOARD_SLUG | Recommended | Board slug to connect to (defaults to main) |
| ELIXIUM_USER_EMAIL | Optional | Your email address. Used as the "Requested by" field when creating stories via AI. If not set, defaults to the API key owner's email. |
💡 Tip: Setting ELIXIUM_USER_EMAIL ensures stories you create through your AI assistant are attributed to you, not the workspace API key owner.
🛠️ Available MCP Tools
Once connected, your AI agent can use these tools:
list_storiesList all stories on the board
get_iteration_contextGet Current + Backlog for planning
create_storyCreate a new story with AC
update_storyUpdate story state, lane, or description
prepare_implementationFetch full context for a story
record_learningLog what you learned from a story
list_epicsList all epics on the roadmap
list_objectivesList workspace objectives (OKRs)
📋 Teaching Your AI Agent
Add a rules file to your repo so the AI knows how to use Elixium effectively.
Rules File Locations
- GitHub Copilot:
.github/copilot-instructions.md - Cursor:
.cursor/rules/elixium.md - Windsurf:
.windsurf/rules/elixium.md - Claude Code:
CLAUDE.mdat repo root - Codex CLI:
AGENTS.mdat repo root
Sample Rules Content
# Elixium Integration At the start of each session: 1. Call `get_iteration_context` to load the board 2. Review Current lane for active work When implementing a story: 1. Call `prepare_implementation` for full context 2. Follow TDD: write tests first 3. Update story state to "started" 4. Commit with story ID in message When complete: 1. Update story state to "finished" 2. Call `record_learning` with outcomes
🔄 Built-in Workflows
Initialize ready-to-use workflows in your project:
# Initialize Elixium workflows
npx @elixium.ai/mcp-server init
This creates .agent/workflows/ with:
load-board-context.md— Load board at session startimplement-story.md— Full story implementation flowmanage-board.md— Create/update stories and epics
🔐 Security
Tenant-Scoped API Keys
Each API key is hardcoded to your workspace. Even if a key is compromised, it only provides access to your specific projects. Keys can be rotated or revoked at any time from workspace settings.
.vscode/mcp.json and.cursor/mcp.json to your .gitignore. Claude Code's .claude/settings.local.json is gitignored by default.🔧 Troubleshooting
Quick Diagnostic Checklist
- Restart your IDE / agent — MCP servers are loaded at startup. After changing config, you must fully restart (not just reload the window). For Claude Code: exit with
Ctrl+Cor/exit, then relaunch. - Test the command in your terminal first — Run the server manually to check for errors:npx -y @elixium.ai/mcp-server@latestIf this fails or hangs, your IDE won't be able to start it either.
- Verify Node.js is available — The MCP server requires Node.js 18+:node --version # Should be v18+
- Check the config key name — GitHub Copilot uses
"servers", all others use"mcpServers". Using the wrong key silently fails. - Verify your API key — Go to your workspace Command Center (Profile tab) and confirm the key is active and not revoked.
Common Errors
"Invalid API Key" or "401 Unauthorized"
- Double-check the key — copy/paste from Command Center, don't type it manually
- Make sure
ELIXIUM_API_URLincludes your tenant subdomain (e.g.,https://my-team.elixium.ai/api, nothttps://elixium.ai/api) - Check the key hasn't been revoked in workspace settings
"Board not found"
- Confirm
ELIXIUM_BOARD_SLUGmatches your board URL exactly (case-sensitive) - Default slug is
main— check your board URL to verify
"Connection closed" or "Failed to parse message"
- npx stdout pollution (most common): When npx downloads the package for the first time, it prints installation output ("changed 38 packages...") to stdout. MCP uses stdout for JSON-RPC, so the IDE can't parse it and the connection drops. Fix: pre-install globally so npx has nothing to download:Then update your config to use the installed binary:
# Install once
npm install -g @elixium.ai/mcp-server
"command": "elixium-mcp", "args": [] - Version managers (asdf, nvm, fnm): These can print reshimming or version-switch messages to stdout/stderr when npx runs, causing the same parse failure. The global install fix above avoids this.
- Windows users: You must wrap npx with
cmd /c:"command": "cmd", "args": ["/c", "npx", "-y", "@elixium.ai/mcp-server@latest"] - If npx isn't found, use the full path:
which npx(macOS/Linux) orwhere npx(Windows) to find it - Corporate proxies can block npx downloads — the global install with
npm install -g @elixium.ai/mcp-serveralso fixes this
Tools not appearing after connection
- The server may be connected but the env vars are missing — check all 4 env vars are set in the
envblock - Try asking your AI: "What MCP tools are available?" to see if Elixium tools are listed
IDE-Specific Diagnostics
🟣 Claude Code
- Run
/mcpto see all server connection statuses - Run
/doctorto validate config files and diagnose errors - Config files:
.claude/settings.local.json(project) or~/.claude/settings.json(user)
🐙 GitHub Copilot (VS Code)
- Open Output panel → select "GitHub Copilot" channel for MCP logs
- Check
.vscode/mcp.jsonuses"servers"(not"mcpServers") - Requires VS Code 1.102+ and Copilot extension
🎯 Cursor
- Go to Settings → MCP to see connected servers and connection status
- Config file:
.cursor/mcp.jsonin project root - Restart Cursor completely after config changes (not just reload)
Still stuck? If none of the above helps, check that the config JSON is valid (no trailing commas, correct brackets). You can validate it by pasting into jsonlint.com or running cat your-config.json | python3 -m json.tool.
Need Help?
Book a quick call with our team to get set up.
📅 Book a 30-min Demo