Skip to content

Commit 139cfca

Browse files
committed
fix: Clean up MCP server configuration section in README
1 parent 76b8a9c commit 139cfca

1 file changed

Lines changed: 22 additions & 51 deletions

File tree

README.md

Lines changed: 22 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -139,29 +139,28 @@ The MCP server simplifies the integration of secure coding prompts into your wor
139139
cp .env.example .env
140140
```
141141

142-
> The MCP server reads configuration from a `.env` file. Customize the following variables as needed:
143-
>
144-
> | Variable | Description | Default |
145-
> | --- | --- | --- |
146-
> | `server.port` | Port the MCP server listens on. | `8080` |
147-
> | `server.ssl` | Whether to use ssl for express server | `false` |
148-
> | `server.ssl.pfx` | Path to pfx file | `localhost.pfx` |
149-
> | `server.ssl.pfx.passphrase` | Passphrase for pfx file | `PFX_PASSPHRASE` |
150-
> | `server.hostname` | Hostname the server binds to. | `localhost` |
151-
> | `logger.transports.console.enabled` | Enable console logging output. | `false` |
152-
> | `logger.transports.console.level` | Log level for console output. | `info` |
153-
> | `logger.transports.amqp.enabled` | Enable AMQP-based logging. | `false` |
154-
> | `logger.transports.amqp.level` | Log level for AMQP transport. | `http` |
155-
> | `logger.transports.amqp.hostname` | Hostname of the AMQP broker. | `localhost` |
156-
> | `logger.transports.amqp.port` | Port for the AMQP broker. | `5672` |
157-
> | `logger.transports.amqp.username` | Username for AMQP authentication. | `guest` |
158-
> | `logger.transports.amqp.password` | Password for AMQP authentication. | `guest` |
159-
> | `logger.transports.amqp.exchange` | Exchange name used for AMQP logging. | `logs` |
160-
> | `logger.transports.amqp.vhost` | Virtual host for AMQP logging. | `/logs` |
161-
> | `logger.transports.amqp.heartbeat` | Heartbeat interval in seconds. | `60` |
162-
> | `logger.transports.amqp.locale` | Locale for the AMQP connection. | `en_US` |
163-
> | `logger.transports.amqp.type` | AMQP exchange type. | `direct` |
164-
> | `logger.transports.amqp.durable` | Whether the AMQP exchange is durable. | `false` |
142+
The MCP server reads configuration from a `.env` file. Customize the following variables as needed:
143+
| Variable | Description | Default |
144+
| --- | --- | --- |
145+
| `server.port` | Port the MCP server listens on. | `8080` |
146+
| `server.ssl` | Whether to use ssl for express server | `false` |
147+
| `server.ssl.pfx` | Path to pfx file | `localhost.pfx` |
148+
| `server.ssl.pfx.passphrase` | Passphrase for pfx file | `PFX_PASSPHRASE` |
149+
| `server.hostname` | Hostname the server binds to. | `localhost` |
150+
| `logger.transports.console.enabled` | Enable console logging output. | `false` |
151+
| `logger.transports.console.level` | Log level for console output. | `info` |
152+
| `logger.transports.amqp.enabled` | Enable AMQP-based logging. | `false` |
153+
| `logger.transports.amqp.level` | Log level for AMQP transport. | `http` |
154+
| `logger.transports.amqp.hostname` | Hostname of the AMQP broker. | `localhost` |
155+
| `logger.transports.amqp.port` | Port for the AMQP broker. | `5672` |
156+
| `logger.transports.amqp.username` | Username for AMQP authentication. | `guest` |
157+
| `logger.transports.amqp.password` | Password for AMQP authentication. | `guest` |
158+
| `logger.transports.amqp.exchange` | Exchange name used for AMQP logging. | `logs` |
159+
| `logger.transports.amqp.vhost` | Virtual host for AMQP logging. | `/logs` |
160+
| `logger.transports.amqp.heartbeat` | Heartbeat interval in seconds. | `60` |
161+
| `logger.transports.amqp.locale` | Locale for the AMQP connection. | `en_US` |
162+
| `logger.transports.amqp.type` | AMQP exchange type. | `direct` |
163+
| `logger.transports.amqp.durable` | Whether the AMQP exchange is durable. | `false` |
165164

166165
3. Start the server
167166

@@ -295,34 +294,6 @@ copilot plugin --help
295294
copilot plugin install --help
296295
```
297296

298-
#### Use the plugin in day-to-day work
299-
300-
Once installed, developers can use the packaged agents and skills in any target project without copying files from this repository.
301-
302-
Examples:
303-
304-
- Ask the `application-security-architect` agent to threat-model a feature or repository.
305-
- Use the `access-control-review` skill to map roles, claims, policies, and enforcement points.
306-
- Use the `dependency-cve-triage` skill to evaluate a known dependency CVE against local code.
307-
- Use the `threat-model` skill when you need durable Markdown output plus script-validated Mermaid diagrams.
308-
309-
Example prompts you can use in Copilot Chat or Copilot CLI:
310-
311-
```text
312-
Use the application-security-architect agent to threat-model this repository.
313-
Use the access-control-review skill to review authorization boundaries in this codebase.
314-
Use the dependency-cve-triage skill to assess CVE-2024-12345 in this project.
315-
```
316-
317-
#### Precedence and overrides
318-
319-
GitHub Copilot CLI loads project and user agents or skills before plugin components.
320-
321-
- If a project-level or user-level agent has the same ID as a plugin agent, the plugin agent is ignored.
322-
- If a project-level or user-level skill has the same `name` as a plugin skill, the plugin skill is ignored.
323-
324-
This means the plugin is best used as a reusable baseline that projects can extend, rather than as a mechanism to forcibly override local customizations.
325-
326297
---
327298

328299
## 📚 Languages Supported

0 commit comments

Comments
 (0)