Skip to main content
Version: v12

Supported MCP Clients

The following AI clients have been tested and are known to operate with BrinqaIQ MCP. Most clients use the stdio connection pattern described below; Open WebUI connects directly over Streamable HTTP.

note

Brinqa does not provide official support for third-party AI clients. Compatibility depends on each client's implementation of the MCP standard and may vary.

Connection pattern​

Clients that use stdio (Claude Desktop, Claude Code CLI, Cursor, Cline, GitHub Copilot, and Goose) use the following connection shape: the mcp-remote npm shim wraps the Streamable HTTP endpoint and exposes it to the client as a local MCP server. Open WebUI connects directly to the Streamable HTTP URL instead. Customers need Node.js for the stdio clients, plus a Brinqa Platform API token — see API Token Authentication.

The base config snippet used by the stdio clients below:

{
"mcpServers": {
"brinqa": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://<your-brinqa-platform-url>/brinqamax/mcp",
"--header",
"Authorization: ApiKey <your-brinqa-platform-api-token>"
]
}
}
}

Replace <your-brinqa-platform-url> with your Brinqa Platform hostname (for example, acme.internal.brinqa.cloud) and <your-brinqa-platform-api-token> with the API token you generated in the Brinqa Platform UI. See API Token Authentication for instructions on generating a token.

Claude Desktop​

Prerequisites​

Configure the MCP server​

  1. Open Claude Desktop on your machine.

  2. Click your profile icon in the bottom-left corner of the sidebar.

  3. Click Settings, then Developer.

  4. Click Edit Config to open claude_desktop_config.json in your default text editor.

    tip

    You can also open the file directly:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  5. Add the base config snippet to the file, replacing the placeholders with your values.

  6. Save the file.

  7. Restart Claude Desktop.

Test the connection​

  1. Open Claude Desktop.

  2. Ask a question that requires BrinqaIQ, such as "Are you connected to BrinqaIQ MCP?" or "List the flows in my Brinqa instance."

  3. Claude should report that the brinqa MCP server is connected and respond using the BrinqaIQ tools.

    BrinqaIQ MCP in Claude

Claude Code CLI​

Prerequisites​

Configure the MCP server​

  1. In the directory where you plan to run Claude Code, create a file named .mcp.json.
  2. Add the base config snippet to the file.
  3. Save the file.

Claude Code automatically picks up .mcp.json files when it starts in that directory. The config is scoped to that directory — repeat for other projects, or add the server to your user-level settings for global access.

Test the connection​

  1. Run claude in that directory.

  2. Ask a question that requires BrinqaIQ, such as "Show me the 3 hosts with the largest number of vulnerabilities."

  3. Claude Code will call the BrinqaIQ MCP tools and return the result inline.

    Claude Code CLI executing a BQL query via the BrinqaIQ MCP integration

Cursor​

Prerequisites​

Configure the MCP server​

Cursor uses the same mcpServers shape as Claude Desktop. Create or edit one of these files:

  • ~/.cursor/mcp.json — applies globally to every Cursor workspace.
  • <workspace>/.cursor/mcp.json — applies only to the current workspace.

Add the base config snippet to whichever file matches your scope. If the file doesn't exist, create it. Restart Cursor after saving.

Cline​

Prerequisites​

Configure the MCP server​

  1. In VS Code, open the Cline extension panel.
  2. Click the MCP Servers icon at the top of the panel.
  3. Click Configure MCP Servers. Cline opens its cline_mcp_settings.json file.
  4. Add the base config snippet to the file, replacing the placeholders with your values.
  5. Save the file. Cline restarts the MCP connection automatically.

GitHub Copilot in VS Code​

Prerequisites​

Configure the MCP server​

  1. In VS Code, open the Command Palette (Cmd+Shift+P on macOS, Ctrl+Shift+P on Windows/Linux).
  2. Run MCP: Add Server.
  3. Select stdio as the server type.
  4. Enter npx as the command, then provide the remaining arguments from the base config snippet when prompted.
  5. VS Code saves the configuration to .vscode/mcp.json in the current workspace.
  6. Reload the window when prompted.

GitHub Copilot Chat will pick up the BrinqaIQ tools on the next session.

tip

To apply the server globally across all workspaces, copy the servers block from .vscode/mcp.json into your VS Code User Settings (settings.json) under the mcp key instead.

Goose​

Prerequisites​

Configure the MCP server​

Goose configures MCP servers through its Extensions UI using individual form fields rather than a JSON file.

  1. Open Goose.

  2. Go to Settings → Extensions → Add custom extension.

  3. Fill in the fields as follows:

    FieldValue
    Namebrinqa
    TypeSTDIO
    Commandnpx
    Arguments-y mcp-remote https://<your-brinqa-platform-url>/brinqamax/mcp --header Authorization:${AUTH_HEADER}
    Environment variableAUTH_HEADER = ApiKey <your-brinqa-platform-api-token>

    Replace the placeholders with your actual hostname and API token.

    Goose splits the Arguments field on whitespace, so the header value cannot be written inline: Authorization: ApiKey <token> would be passed as three separate arguments and authentication would fail. Supplying the value through the AUTH_HEADER environment variable avoids this, and keeps the token out of the process argument list. Note that there is no space after the colon in Authorization:${AUTH_HEADER}; the space belongs inside the environment variable value.

  4. Save the extension and enable it.

  5. Start a new Goose session — Goose loads extensions at session start, so the BrinqaIQ tools will not appear until you open a new chat.

Open WebUI​

Prerequisites​

Configure the MCP server​

  1. Sign in to Open WebUI as an administrator.

  2. Go to Admin Panel → Settings → Tools.

  3. Click + to add a new tool server.

  4. Set the server URL to:

    https://<your-brinqa-platform-url>/brinqamax/mcp

  5. Add a request header with key Authorization and value ApiKey <your-brinqa-platform-api-token>.

  6. Save the configuration.

  7. Reload the Open WebUI page (or restart the service if you modified a server-side config file) for the BrinqaIQ tools to appear.

note

The exact navigation path may vary by Open WebUI version. If the path above does not match your UI, see the Open WebUI MCP documentation for your installed version.

BrinqaIQ MCP in Open WebUI

Troubleshooting​

SymptomLikely cause
Client reports "MCP server failed to start"npx cannot be found on PATH. Install Node.js and restart the client.
Tools list is emptyThe API token is invalid or expired. Generate a new token and update the config.
Destructive tool runs without a promptYour client does not implement MCP tool annotations. Use a client that honors destructiveHint, or revoke API token permissions you don't want the agent to use.
401 UnauthorizedThe Authorization header is malformed. Confirm it uses ApiKey (note the space) and the token value with no surrounding quotes.
404 Not Found on /brinqamax/mcpYour Brinqa Platform is below 12.3. Use the v11 version of this page for the legacy OpenAPI-proxy configuration.