Installation

Prerequisites

Before installing the plugin for any tool, make sure you have:

1. A Bright API token — create one in Bright under Organization → API Keys or Project → API Keys. See Personal API Key Scopes.
2. Your Bright cluster hostname — typically app.brightsec.com (EU cluster: eu.brightsec.com).

Export both as environment variables so the plugin and the Bright Repeater can read them:

export BRIGHT_HOSTNAME="app.brightsec.com"
export BRIGHT_TOKEN="your-bright-api-token"

📘

Persist these in your shell profile (~/.zshrc, ~/.bashrc) so every session has them.

Install for your tool

Each tool has its own native install steps. Follow the README for your tool:

All packages use the same Bright MCP server under the hood — the only differences are tool-specific plugin mechanics and frontmatter.

Verify the installation

After installing, confirm:

1. The Bright MCP server (brightsec) is connected and active in your tool's MCP settings.
2. The Bright agents appear in the agent list (or as available skills, depending on the tool) — see Agents & Skills for what to expect.
3. Environment variables are accessible — run echo $BRIGHT_HOSTNAME and echo $BRIGHT_TOKEN in the same shell.

Update & uninstall

Each package README includes tool-specific update and uninstall instructions. The general pattern:

• Update: refresh the marketplace catalog, then update the plugin (or git pull for clone-based setups).
• Uninstall: disable or remove the plugin from the tool's settings, then optionally remove the marketplace source.

See the per-tool README linked above for exact commands.

Troubleshooting

For deeper troubleshooting, see the Advanced usage section in each tool's README.