Customer Portal Sign in

Symbol MCP Integration with External AI Assistants

This article provides step-by-step instructions for configuring and verifying the Symbol MCP integration.

The Symbol Model Context Protocol (MCP) server allows security operators and administrative users to execute key Symbol platform workflows, such as querying users, listing companies, checking training progress, and making course assignments directly from AI assistant environments like Claude.ai, OpenCode, and others.

Prerequisites

Before connecting Symbol to your AI client, obtain your Symbol API token:

  1. Log in to the Symbol Admin Portal
  2. Navigate to Settings (for single-company environments) or Settings → Integrations (for MSP environments).
  3. Copy your existing API Token (or regenerate one if none exists).

1. Configuring Symbol MCP in OpenCode

OpenCode connects to remote MCP servers via its central JSON configuration file located in your user home directory.

Step-by-Step Setup

  1. Open or create the global OpenCode configuration file located at:

    ~/.config/opencode/opencode.json (or ~/.config/opencode/opencode.jsonc)

  2. Add the symbol configuration block under the mcp root key:

{
  "mcp": {
    "symbol": {
      "type": "remote",
      "url": "https://mcp.symbolsecurity.com/mcp",
      "enabled": true,
      "oauth": false,
      "headers": {
        "Authorization": "Bearer [Symbol API Token]"
      }
    }
  }
}

Note: Replace [Symbol API Token] with your actual API token copied from the Symbol portal. The "oauth": false flag ensures OpenCode passes the authorization header directly without attempting standard OAuth discovery.

2. Configuring Symbol MCP in Claude (Claude.ai)

For Claude Team or Enterprise setups, administrators can enable custom connectors globally, or operators can configure individual custom connectors.

Step-by-Step Setup

  1. Open Claude.ai and navigate to Customize → Connectors (or Organization Settings → Connectors for admins).

  2. Click Add Custom Connector

  3. Set the connector details:

  4. Add a custom HTTP Request Header:

    • Header Name: Authorization
    • Value: Bearer [Symbol API Token]

  5. Save and connect.

3. Verifying the Connection

Once configured, verify that Symbol MCP is active and connected.

In OpenCode

Run the built-in /MCP status command in your chat window or terminal sessionor:

opencode mcp list

Verify that symbol shows a Connected / Active status.

In Claude

  1. Open a new chat in Claude.
  2. Click + → Connectors and toggle Symbol to ON.
  3. Type /MCP or ask: “Is the Symbol MCP server connected?”

4. Available v1 Tools & Testing Commands

Once connected, you can run any of the v1 supported actions directly in chat:

Supported Tools

  • List managed MSP companies (GET /msp/companies).
  • Retrieve specific company details (GET /msp/companies/{id}).
  • Retrieve users for single-company or MSP contexts (GET …/users).
  • Fetch detailed user profiles (GET …/users/{id}).
  • List training courses and content (GET …/training/assets).
  • View assigned training records (GET …/training/list).
  • Assign a training module to specific users (POST …/training/assign).
  • Fetch scheduled training and security programs (GET …/programs/schedule).

Example Prompts to Try

  • “List my companies.” (MSP context)
  • “List our active users.”
  • “Who is currently overdue on training?”
  • “What training programs are scheduled for this month?”
  • “Assign ‘Phishing Awareness 101’ to user [User Email] due next Friday.”

Security Note on Destructive/Write Actions: When running write operations like assign_training, your AI client will display a prompt requiring explicit confirmation before the operation executes. Confirm the prompt to apply changes.