Setup
Required values, URL shape, and team scoping
Use this page to connect Codex, Claude, or another AI assistant to the VRPlatform MCP server.
When your MCP client asks for a server name, use vrplatform.
That name is only a local client alias. The VRPlatform MCP server never
receives it. MCP resources exposed by the server use vrplatform:// URIs.
1. Choose The Endpoint
Use the directory endpoint to read and manage accounting records and search product documentation:
https://mcp.vrplatform.app/directoryIt exposes eleven tools, including confirmed record creation, updates, and deletion
through reviewed API routes. It cannot initiate money transfers or manage payment
credentials. See Capabilities for the permitted operations.
Use /directory without a trailing slash.
Existing custom connectors can use the full API endpoint:
https://mcp.vrplatform.app/The custom endpoint stays at / and includes confirmed mutations. /mcp is
not an endpoint.
2. Connect With OAuth
Use your chosen MCP URL without query parameters. For the directory connector:
https://mcp.vrplatform.app/directoryWhen the MCP client connects, VRPlatform returns OAuth metadata and the client should prompt you to sign in. The MCP server then uses your VRPlatform user permissions for team lookup and API calls.
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/directory?team_id=<team-id>tenant_id is accepted as an alias for team_id, but new configurations should
use team_id.
4. API Token Fallback
Use an API token only when your MCP client cannot complete OAuth.
In the VRPlatform app, go to Settings > API tokens, then add the token as
api_key:
https://mcp.vrplatform.app/directory?api_key=<api-token>For a default team with an API token:
https://mcp.vrplatform.app/directory?api_key=<api-token>&team_id=<team-id>Required Values Reference
| Value | Description |
|---|---|
| Server name | Use vrplatform when your MCP client asks for a name. |
| MCP URL | The VRPlatform MCP endpoint. |
| Sign-in | OAuth is the primary authentication method. |
| API token | Optional fallback from Settings > API tokens; sent as api_key. |
| Team id | Optional default team for assistant requests. |
If the API token contains special URL characters, URL-encode it before putting it in the query string.
Treat fallback API-token URLs as sensitive. They contain 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_idin 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.
On the custom endpoint, partner API routes under /partner keep the API token's
partner scope. The MCP
server does not send the default or tool-level team id on those routes; source
and target team ids belong in the endpoint's documented query or body fields.
Permission Scope
Both endpoints apply your VRPlatform account or API token permissions to data
access. /directory also enforces an explicit list of reviewed API operations
and input fields on the server. URL parameters, headers, and tool arguments cannot
expand that list. Both endpoints require confirm=true for mutations and preserve
API permissions and accounting locks.
Directory writes can record prior payments, reconcile bank records, prepare and publish owner statements, and correct accounting entries. Owner invitations and statement emails require an explicit user request. Provider payment execution, retries, credential changes, and arbitrary operations remain unavailable.
Data Handling
Clerk handles sign-in, and Cloudflare hosts the MCP server. Selected tool inputs, credentials, and team context go to the VRPlatform API. Returned team data goes to the connecting Claude client or other assistant, so connect only with data you are allowed to share with that client. Sentry receives operational telemetry.
See the privacy policy. Contact support@vrplatform.app about connector data handling.
Revoking Access
To disconnect an assistant, remove the vrplatform server from your client
configuration.
If you used an api_key fallback URL, also rotate or delete that API token in
Settings > API tokens in the VRPlatform dashboard.
The MCP server does not store credentials of its own; it only forwards what the client sends. If you need an OAuth grant revoked, contact VRPlatform.
Public Endpoints
The MCP server at https://mcp.vrplatform.app/ forwards API calls to
https://api.vrplatform.app. Use a sign-in session, API token, and team id for
your VRPlatform account. The MCP client cannot override the upstream API host.