Skip to main content

Gateway Connection

Once your gateway is running, connect your AI clients to it.

Claude

Connect a running gateway to Claude console, Claude Code, or GitHub Copilot (VS Code) — no code required.

Claude Console

Connect directly to the gateway URL through the Claude console's native connector interface.

Important: Do not include /mcp in the gateway URL when registering in the Claude console.

Static Registration

  1. Click the Export button for your Gateway and enter the app name and callback URL
  2. Copy the generated client_id, client_secret, and gateway URL
  3. In the Claude console, go to ConnectorsAdd Custom Connector
  4. Enter the gateway name and URL; in Advanced Settings, enter the client_id and client_secret
  5. Click Connect — you will be redirected to the VirtueAgent authentication page
  6. Log in with your username and password to complete the connection

Gateway Connect

Dynamic Registration

  1. Copy the URL of the selected Gateway
  2. In the Claude console, go to ConnectorsAdd Custom Connector
  3. Enter the gateway name and URL — no advanced settings needed
  4. Click Connect and log in with your username and password

Authentication

On the authentication page, you can log in with username and password or use auto-authentication based on a saved cookie.

Gateway Connect

Claude Code

Prerequisites:

  • Claude Code installed on your machine
  • A running Gateway (status: Running)

Steps:

  1. Copy your Gateway URL from the Gateway tab
  2. Add the gateway as an MCP server:
claude mcp add --transport http virtueagent-gateway https://your-gateway-url.virtueai.io/mcp
  1. Start Claude Code — a browser window opens for authentication. Log in with your VirtueAgent credentials.
  2. Run /mcp inside Claude Code to verify the connection:

Claude Code MCP Connection

GitHub Copilot (VS Code)

Note: VS Code Copilot does not support automatic OAuth flows for MCP servers. Use an API Key instead. See API Key Management to create one.

Prerequisites:

  • VS Code 1.99+ with GitHub Copilot extension
  • A running Gateway
  • An API Key created from the VirtueAgent dashboard

Steps:

  1. Create an API Key in the VirtueAgent dashboard and copy it
  2. Copy your Gateway URL
  3. Create .vscode/mcp.json in your project:
{
"inputs": [
{
"type": "promptString",
"id": "gateway-api-key",
"description": "Virtue Gateway API Key",
"password": true
}
],
"servers": {
"virtueagent-gateway": {
"type": "http",
"url": "https://your-gateway-url.virtueai.io/mcp",
"headers": {
"X-API-Key": "${input:gateway-api-key}"
}
}
}
}
  1. Open VS Code, enter your API Key when prompted, and click Configure Tool

Configure Tool

  1. Open GitHub Copilot Chat in Agent mode to verify the connection:

Copilot MCP Connection

OpenAI

note

Detailed documentation for connecting OpenAI clients to the Virtue Gateway is coming soon.

Gemini

note

Detailed documentation for connecting Gemini clients to the Virtue Gateway is coming soon.