API Access
Team-scoped reads, mutations, and safety rules
API Access
MCP API tools forward requests to the API environment that matches the MCP host:
| MCP host | API upstream |
|---|---|
https://mcp.vrplatform.app/ | https://api.vrplatform.app |
https://staging.mcp.vrplatform.app/ | https://staging.api.vrplatform.app |
The MCP client cannot override the upstream API host.
Connecting to MCP only requires api_key. Team scope is required only when an
API tool call needs to operate inside a team.
Reads
Use vrt_api_read for GET requests.
Team discovery reads can omit team scope:
GET /teamsGET /teams/lookupGET /teams/{id}GET /teams/issuesGET /teams/{id}/issues
Every other read requires either:
- URL-level
team_idas the default team - tool-level
teamId
The worker forwards that value as x-team-id.
Mutations
Use vrt_api_mutation for POST, PATCH, PUT, or DELETE.
Mutations can change data in the connected environment. They require all of the following:
methodset toPOST,PATCH,PUT, orDELETE- a team scope from default URL-level
team_idor tool-levelteamId confirm: true
A tool-level teamId can switch teams per call, even when the MCP URL has no
team_id.
For read-only assistant workflows, disable vrt_api_mutation in the client when
the client supports tool deny lists.
API Shape Discovery
Before calling an endpoint, ask the client to read:
vrt://api/openapi-contextvrt://api/path/<encoded-path>vrt://api/path/<encoded-path>/<method>
For example:
vrt://api/path/%2Freservations
vrt://api/path/%2Freservations/GET