docs(mcp): surface install extra in quick-start and add stdio caveat#216
Open
rodboev wants to merge 1 commit into
Open
docs(mcp): surface install extra in quick-start and add stdio caveat#216rodboev wants to merge 1 commit into
rodboev wants to merge 1 commit into
Conversation
Signed-off-by: Rod Boev <rod.boev@gmail.com>
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
Surface the MCP-capable install path at the first Quick Start decision point, then tighten the README and CLI help so
skillspector mcpis described as the current FastMCP stdio path that requiresskillspector[mcp].Refs #199
Root cause
The README leads with a base-only
uv tool installcommand, while the MCP-specific install requirement appears later in the MCP section. Theskillspector mcphelp text repeats that split by describing stdio before users see the optional-extra requirement, so they can hit the missing-dependency path before they ever learn which install command they needed.Diff Notes
README.mduvinstall path explicitly CLI-only.skillspector mcp.skillspector mcprequiresskillspector[mcp].#199without framing it as fixed.src/skillspector/cli.pymcpcommand help text so the optionalmcpextra is visible before the import-failure path.httpfor remote or A2A callers.Scope
This PR changes only
README.mdandsrc/skillspector/cli.py. It does not changesrc/skillspector/mcp_server.py, add transport diagnostics, or claim to resolve the stdio initialize hang from#199.Verification
rtk git -C "D:\Repos\SkillSpector-pr-mcp-docs-install-scope" diff -- README.md src\skillspector\cli.py- keeps the slice to the intended README and CLI help surfaces.Select-String -Pattern 'skillspector[mcp]' -SimpleMatch -Path 'D:\Repos\SkillSpector-pr-mcp-docs-install-scope\README.md','D:\Repos\SkillSpector-pr-mcp-docs-install-scope\src\skillspector\cli.py'- confirms the optional-extra guidance is visible on both user-facing surfaces.rtk grep "skillspector mcp" "D:\Repos\SkillSpector-pr-mcp-docs-install-scope\README.md" "D:\Repos\SkillSpector-pr-mcp-docs-install-scope\src\skillspector\cli.py"- confirms the updated MCP wording appears in both places users read it.cmd /d /s /c "cd /d D:\Repos\SkillSpector-pr-mcp-docs-install-scope && rtk uv run skillspector mcp --help"- verifies the rendered help surfaces the optional extra before the runtime import-failure path.Lint & Test (Python 3.12),Lint & Test (Python 3.13), andDCO Check- pending maintainer approval if fork checks are gated.Notes
This is the repo-owned docs and help-text slice only. The runtime stdio initialize hang remains outside this PR.