docs: address setup friction points and client config pitfalls (#123) - #312
Draft
dandye wants to merge 1 commit into
Draft
docs: address setup friction points and client config pitfalls (#123)#312dandye wants to merge 1 commit into
dandye wants to merge 1 commit into
Conversation
- Document uv installation and explain when/why absolute paths are required for desktop GUI clients. - Clarify virtual environment vs. standalone uv usage. - Highlight directory path levels and the SCC copy-paste trap (scc_mcp.py vs server.py). - Clarify --env-file argument placement after 'run'. - Document SOAR SSL certificate / certifi configuration requirements. - Provide /bin/bash -c bypass recipe when uv is unavailable or in existing venvs. Closes #123
dandye
marked this pull request as draft
September 9, 2026 02:31
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.
Resolves #123
Summary of Changes
This PR updates the setup, configuration, and troubleshooting documentation across
README.mdanddocs/usage_guide.mdto address common friction points encountered during first-time onboarding:uvInstallation & Desktop GUI Client PATH Gotchas:uvinstallation options.PATHadditions (e.g.,~/.local/bin/uv), resulting inspawn uv ENOENT.which uvand specifying the full absolute path in"command".uv:uvor Python from an existing virtual environment is supported, a standalone globaluvinstallation is recommended becauseuv runhandles per-server isolation automatically.server.pyfrom nested package directories (secops_mcp,secops_soar_mcp,gti_mcp), whereas SCC runsscc_mcp.pydirectly fromserver/scc/.--directoryto<repo>/server/or copy-pastingserver.pyfor SCC.--env-fileFlag Placement:--env-fileis a flag touv runand must appear afterrunin theargsarray.certifi:Install Certificates.commandandSSL_CERT_FILEwithcertifi)./bin/bash -c):/bin/bash -cfallback configuration example for environments whereuvcannot be located by GUI desktop clients or when using existing virtual environments.