@@ -28,6 +28,8 @@ export STACKROX_MCP__TOOLS__VULNERABILITY__ENABLED=true
2828./stackrox-mcp
2929```
3030
31+ The server will start on ` http://localhost:8080 ` by default. See the [ Testing the MCP Server] ( #testing-the-mcp-server ) section for instructions on connecting with Claude Code.
32+
3133## Configuration
3234
3335The StackRox MCP server supports configuration through both YAML files and environment variables. Environment variables take precedence over YAML configuration.
@@ -80,6 +82,15 @@ Global MCP server settings.
8082| --------| ---------------------| ------| ----------| ---------| -------------|
8183| ` global.read_only_tools ` | ` STACKROX_MCP__GLOBAL__READ_ONLY_TOOLS ` | bool | No | ` true ` | Only allow read-only tools |
8284
85+ #### Server Configuration
86+
87+ HTTP server settings for the MCP server.
88+
89+ | Option | Environment Variable | Type | Required | Default | Description |
90+ | --------| ---------------------| ------| ----------| ---------| -------------|
91+ | ` server.address ` | ` STACKROX_MCP__SERVER__ADDRESS ` | string | No | ` localhost ` | HTTP server listen address |
92+ | ` server.port ` | ` STACKROX_MCP__SERVER__PORT ` | int | No | ` 8080 ` | HTTP server listen port (must be 1-65535) |
93+
8394#### Tools Configuration
8495
8596Enable or disable individual MCP tools. At least one tool has to be enabled.
@@ -97,6 +108,63 @@ Configuration values are loaded in the following order (later sources override e
971082 . YAML configuration file (if provided via ` --config ` )
981093 . Environment variables (highest precedence)
99110
111+ ## Testing the MCP Server
112+
113+ ### Starting the Server
114+
115+ Start the server with a configuration file:
116+
117+ ``` bash
118+ ./stackrox-mcp --config examples/config-read-only.yaml
119+ ```
120+
121+ Or using environment variables:
122+
123+ ``` bash
124+ export STACKROX_MCP__CENTRAL__URL=" central.example.com:8443"
125+ export STACKROX_MCP__TOOLS__VULNERABILITY__ENABLED=" true"
126+ ./stackrox-mcp
127+ ```
128+
129+ The server will start on ` http://localhost:8080 ` by default (configurable via ` server.address ` and ` server.port ` ).
130+
131+ ### Connecting with Claude Code CLI
132+
133+ Add the MCP server to Claude Code using command-line options:
134+
135+ ``` bash
136+ claude mcp add stackrox \
137+ --name " StackRox MCP Server" \
138+ --transport http \
139+ --url http://localhost:8080
140+ ```
141+
142+ ### Verifying Connection
143+
144+ List configured MCP servers:
145+
146+ ``` bash
147+ claude mcp list
148+ ```
149+
150+ Get details for a specific server:
151+
152+ ``` bash
153+ claude mcp get stackrox
154+ ```
155+
156+ Within a Claude Code session, use the ` /mcp ` command to view available tools from connected servers.
157+
158+ ### Example Usage
159+
160+ Once connected, interact with the tools using natural language:
161+
162+ ** List all clusters:**
163+ ```
164+ You: "Can you list all the clusters from StackRox?"
165+ Claude: [Uses list_clusters tool to retrieve cluster information]
166+ ```
167+
100168## Development
101169
102170### Available Make Targets
0 commit comments