Setup

Use this page to build the MCP URL you will paste into Codex, Claude, or another AI assistant.

1. Choose The Environment

Most users should use production:

https://mcp.vrplatform.app/

Use staging only when VRPlatform asks you to test against staging:

https://staging.mcp.vrplatform.app/

The URL should end at /. Do not add /mcp unless VRPlatform gives you a URL that already includes it.

2. Find Your API Token

In the VRPlatform app, go to Settings > API tokens.

Create or copy an API token there. The UI calls this an API token; the MCP URL parameter is named api_key.

Add the token to the MCP URL:

https://mcp.vrplatform.app/?api_key=<api-token>

3. Optional: Add A Default Team

You do not need a team id to connect. If you leave it out, the assistant can look up teams later and choose the right one for each request.

If you want the assistant to start with one default team, add team_id:

https://mcp.vrplatform.app/?api_key=<api-token>&team_id=<team-id>

tenant_id is accepted as an alias for team_id, but new configurations should use team_id.

Required Values Reference

If the API token contains special URL characters, URL-encode it before putting it in the query string.

Treat the full MCP URL as sensitive. It contains an API token and should not be committed to source control, pasted into public chats, or shared in screenshots.

Team Scope

Most VRPlatform data belongs to a team, but the assistant does not need a team selected before it connects.

Use one of these patterns:

• omit team_id, ask the assistant to look up the team, then use that team for the request
• include team_id in the MCP URL when most calls should use one default team

The MCP server does not lock the session to one team. A tool-level teamId can select a different team for that call.

Environment

Choose the MCP host for the VRPlatform environment you want to use:

Use an API token and team id from the same environment as the MCP host. The MCP client cannot override the upstream API host.