Skip to main content

Connect an AI Assistant Using VRTrust MCP

Connect an AI assistant such as Claude or Codex to your VRTrust account using the VRPlatform MCP server

Learn how to connect an AI assistant such as Claude or Codex to your VRTrust account using the VRPlatform MCP server, so your assistant can look up data, answer product questions, and take action on your behalf.

Who This Applies To: This article is intended for VRTrust users who are connecting an AI assistant to their VRTrust account to access team data, search documentation, and run API requests.


Overview

VRTrust MCP is a server that allows compatible AI assistants to read and interact with your VRTrust data. Once connected, your assistant can search the VRTrust knowledge base, find teams you have access to, retrieve account data, and make changes after you explicitly confirm each action.

Connection requires an API token from your VRTrust account and a compatible AI assistant. The setup process takes only a few minutes and does not require any coding.

The MCP connection is read-friendly by default. Your assistant will not make changes to your data unless you explicitly confirm the action in the conversation.


Steps

Step 1: Get Your API Token

  1. Log in to VRTrust and navigate to Settings > API tokens.

  2. Create a new token or copy an existing one.

  3. Keep this token somewhere secure. You will add it to your MCP URL in the next step.


Step 2: Build Your MCP URL

Your MCP URL is what you paste into your AI assistant to establish the connection.

  1. Start with the production MCP base URL:

    https://mcp.vrplatform.app/
  2. Add your API token as the api_key parameter:

    https://mcp.vrplatform.app/?api_key=<your-api-token>
  3. Optionally, add a default team ID if you want the assistant to start scoped to one team:

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

    If you leave out team_id, your assistant can still look up your teams during the conversation.


Step 3: Add the MCP to Your AI Assistant

The steps for adding an MCP server vary by assistant. See the client-specific guides for:

In most cases, you will paste the MCP URL into a remote MCP server field in your assistant's settings.


Step 4: Verify the Connection

Once connected, ask your assistant to check the server status:

"Use VRTrust MCP to check the server status."

Your assistant should confirm that the connection is active and that API access is configured. If you added a team_id, it will also confirm the default team scope.


Example

A user wants to use Claude to look up open owner statements for their team.

After connecting the MCP, they can ask:

"Use VRTrust MCP to find the team named Beachside Properties and show me any open statements."

Claude will look up the team, read the relevant data, and present the results — without making any changes unless the property manager confirms an action.


Important Considerations

  • The full MCP URL contains your API token. Treat it like a password. Do not share it in screenshots, public chats, or source control.

  • For users with access to multiple teams: The MCP server does not lock the session to one team. You can scope individual requests to a different team during the conversation using a teamId parameter at the tool level.

  • Your assistant will only make changes (create, update, or delete data) when you explicitly confirm the action in the conversation.

  • Use an API token and team ID from the same environment as your MCP host. Mixing production tokens with staging URLs, or vice versa, will cause connection errors.

  • If your API token contains special characters, URL-encode it before adding it to the MCP URL.

  • The staging MCP URL (https://staging.mcp.vrplatform.app/) should only be used when VRTrust has asked you to test against staging.


Troubleshooting

My assistant says it cannot connect

  • Confirm your API token is correct and was copied without extra spaces.

  • Check that the MCP URL ends with / and does not include /mcp unless VRTrust provided a URL that already includes it.

  • Verify you are using a token from the same environment as the MCP host (production vs. staging).

My assistant cannot find my team

  • If you did not include a team_id in the MCP URL, ask your assistant to look up the team by name: "Find the team named [team name]."

  • Confirm the team name is spelled correctly and that your account has access to it.

My assistant says API access is not configured

  • Ask your assistant to run vrt_server_status and share the output. This will show whether authentication is set up correctly.

  • Re-check your API token and rebuild the MCP URL if needed.


Frequently Asked Questions

Do I need a team ID to connect?

No. team_id is optional. If you leave it out, your assistant can look up teams by name during the conversation and scope requests at that point.

Can my assistant make changes to my data without me knowing?

No. The MCP server exposes mutation tools, but your assistant will present the action and wait for your explicit confirmation before making any changes.

What can my assistant do once connected?

Your assistant can search VRTrust product documentation, find teams you have access to, read account data, and make changes after you confirm them. It can also browse available API endpoints to help you understand what data is accessible.


Related Help Articles

Did this answer your question?