Repository navigation
Conversation
…s and Sphinx docs Add Corporate Proxy Configuration sections to the Sphinx docs and package READMEs that lacked them after PR #273 and PR #311. - Document HTTP_PROXY, HTTPS_PROXY, and NO_PROXY in docs/servers/secops_soar_mcp.md, server/gti/README.md, docs/servers/gti_mcp.md, server/secops/README.md, docs/servers/secops_mcp.md, server/scc/README.md, and docs/servers/scc_mcp.md. - Specify the TLS inspection CA bundle variable used by each client transport (SSL_CERT_FILE for aiohttp in gti and secops-soar, REQUESTS_CA_BUNDLE for requests in secops, and GRPC_DEFAULT_SSL_ROOTS_FILE_PATH plus REQUESTS_CA_BUNDLE for grpcio and Google Cloud auth in scc-mcp). - Update step 3 in docs/usage_guide.md to name the CA bundle variables per server.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for configuring corporate proxies across multiple MCP servers, detailing the use of standard proxy environment variables and custom SSL/CA certificates. The review feedback suggests minor improvements for consistency and accuracy, specifically recommending the plural form 'variable(s)' when referring to multiple SSL configuration variables in the usage guide, and ensuring that HTTP_PROXY is consistently listed before HTTPS_PROXY across all server documentation.
| ``` | ||
|
|
||
| 3. **Custom SSL/CA Certificates (SSL Decryption/Inspection)**: If your corporate proxy intercepts SSL traffic, point `SSL_CERT_FILE` to your corporate CA certificate bundle. | ||
| 3. **Custom SSL/CA Certificates (SSL Decryption/Inspection)**: If your corporate proxy intercepts TLS traffic, point the appropriate certificate variable to your corporate CA bundle (`SSL_CERT_FILE` for `gti` and `secops-soar`, `REQUESTS_CA_BUNDLE` for `secops`, and `GRPC_DEFAULT_SSL_ROOTS_FILE_PATH` plus `REQUESTS_CA_BUNDLE` for `scc-mcp`). |
There was a problem hiding this comment.
Since scc-mcp requires setting two environment variables (GRPC_DEFAULT_SSL_ROOTS_FILE_PATH and REQUESTS_CA_BUNDLE), it is more accurate to refer to "variable(s)" in plural form.
Suggested change
| 3. **Custom SSL/CA Certificates (SSL Decryption/Inspection)**: If your corporate proxy intercepts TLS traffic, point the appropriate certificate variable to your corporate CA bundle (`SSL_CERT_FILE` for `gti` and `secops-soar`, `REQUESTS_CA_BUNDLE` for `secops`, and `GRPC_DEFAULT_SSL_ROOTS_FILE_PATH` plus `REQUESTS_CA_BUNDLE` for `scc-mcp`). | |
| 3. **Custom SSL/CA Certificates (SSL Decryption/Inspection)**: If your corporate proxy intercepts TLS traffic, point the appropriate certificate variable(s) to your corporate CA bundle (`SSL_CERT_FILE` for `gti` and `secops-soar`, `REQUESTS_CA_BUNDLE` for `secops`, and `GRPC_DEFAULT_SSL_ROOTS_FILE_PATH` plus `REQUESTS_CA_BUNDLE` for `scc-mcp`). |
|
|
||
| ### Corporate Proxy Configuration | ||
|
|
||
| The server honors standard proxy environment variables (`HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: |
There was a problem hiding this comment.
For consistency across all server documentation files, list HTTP_PROXY before HTTPS_PROXY.
Suggested change
| The server honors standard proxy environment variables (`HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: | |
| The server honors standard proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: |
|
|
||
| ### Corporate Proxy Configuration | ||
|
|
||
| The server honors standard proxy environment variables (`HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: |
There was a problem hiding this comment.
For consistency across all server documentation files, list HTTP_PROXY before HTTPS_PROXY.
Suggested change
| The server honors standard proxy environment variables (`HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: | |
| The server honors standard proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`). To run behind a corporate proxy, set these variables in your environment or pass them in the `env` block of your MCP client settings: |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
Corporate Proxy Configurationsections to the server READMEs and Sphinx server pages that lacked them after PR #273 (gti) and PR #311 (secops-soar).What Changed
### Corporate Proxy Configurationtodocs/servers/secops_soar_mcp.md,server/gti/README.md,docs/servers/gti_mcp.md,server/secops/README.md,docs/servers/secops_mcp.md,server/scc/README.md, anddocs/servers/scc_mcp.md.gtiandsecops-soar(aiohttpwithtrust_env=True):SSL_CERT_FILEsecops(secops-wrapper/requests):REQUESTS_CA_BUNDLEscc-mcp(grpcio+google-auth):GRPC_DEFAULT_SSL_ROOTS_FILE_PATHandREQUESTS_CA_BUNDLEdocs/usage_guide.mdto list the CA bundle variables per server.README.mdunchanged to keep the landing page brief.Checks
git diff --check: zero whitespace errors.sphinx-build -M htmlagainstdocs/: all 333 pages built cleanly, and#corporate-proxy-configurationlinks resolve to the anchor inusage_guide.html.