Skip to main content

Prerequisites

  • VS Code with GitHub Copilot installed
  • An Opus API key (see Authentication)
  • Your organization enabled for the Opus MCP server (see Overview)
  • The MCP URL for your Opus deployment. The examples use https://mcp.opus.com. For other deployments, ask the Opus team (see Server URLs)

Add the Server

VS Code reads MCP servers from two kinds of configuration. Use option 1 for new setups. Option 2 uses the older editor format, which VS Code will remove in February 2027. Set your key in the OPUS_API_KEY environment variable of the shell or session that starts VS Code. Then add the server to ~/.copilot/mcp-config.json for every workspace, or to .mcp.json in the workspace root for one project:
~/.copilot/mcp-config.json
To add the other categories, add opus-discover and opus-admin entries under mcpServers with the matching URLs and the same headers block.
This format does not support input prompts. If you set OPUS_API_KEY after VS Code started, restart VS Code. See the VS Code MCP configuration reference.

Option 2: Editor configuration (deprecated)

VS Code deprecated this format and will remove it in February 2027. Use option 1 for new setups.
Add the server to .vscode/mcp.json in your workspace. For a server in every workspace, run MCP: Open User Configuration from the Command Palette and add it there. This format can ask for your key in a secure prompt:
.vscode/mcp.json
VS Code asks for the key the first time the server starts and stores it securely, so the key never appears in the file. You can commit this file: each teammate enters their own key. To add the other categories, add opus-discover and opus-admin entries under servers that refer to the same ${input:opus-api-key}.

Verify

Ask the agent (Copilot in agent mode) to call list_workspaces on opus-build. A list of your workspaces means the connection works.
A server that starts without an error proves only that the MCP handshake worked. Always confirm with a real tool call such as list_workspaces.

Troubleshooting

See Troubleshooting for all errors.