fix(mcp): include wikitext in the mcp extra, streamline tools docs - #203
Merged
Merged
Conversation
- register the installed `osw-mcp` command instead of `uvx --from` - editable install from a checkout for CLI and MCP development - extras combine, e.g. `osw[mcp,wikitext]` - when `--reinstall` is needed, and the Windows Scripts lock - keep the entity model regeneration warning and name the read-only exception
- osw.wiki_tools warns at import time without mwparserfromhell - on stdio that warning reaches every MCP client's log
- index.md: one install path, no developer instructions - mcp.md: name both registration options in the intro - mcp.md: "Which command to register for the MCP server", two options - mcp.md: the editable developer install now lives in Notes for developers - drop `osw[mcp,wikitext]`, since `osw[mcp]` now implies it
- uvx runs the installed tool when it satisfies the specification - an explicit version keeps a server independent of it
Contributor
Release previewMerging this PR would release v2.6.3 (current: Changelog preview (truncated)## v2.6.3 (2026-09-22)
### Bug Fixes
- **mcp**: Include the wikitext extra in the mcp extra
([`adf50d2`](https://github.com/OpenSemanticLab/osw-python/commit/adf50d21405cbc396491929c6faa54b3de1caf8d))
### Documentation
- **mcp**: Note that uvx reuses an installed osw tool
([`c492583`](https://github.com/OpenSemanticLab/osw-python/commit/c492583db6a7a19647a828881b7fd45992697c96))
- **tools**: Document uv tool install for osw and osw-mcp
([`d691ef4`](https://github.com/OpenSemanticLab/osw-python/commit/d691ef428eff2735cb92f6ad0ea55363b6361c2a))
- **tools**: Streamline install and registration guidance
([`ed18174`](https://github.com/OpenSemanticLab/osw-python/commit/ed1817465d1e9518c9903742276ce5a2352e8066))
Preview via python-semantic-release and conventional commits. |
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.
Changes
Packaging
pyproject.toml: themcpextra now requiresosw[wikitext], somwparserfromhellis installed with every MCP install.uv.lockupdated accordingly.docs/tools/index.mduv tool install "osw[mcp]", with a note on the tool bin directory,uv tool update-shelland quoting the brackets for zsh.pip install,uv addanduvxmoved into a collapsed "Other ways to install" block.mcp.md.docs/tools/mcp.mduvxor an installedosw[mcp], with a link to the decision section.claude mcp add ... -- osw-mcpentry and its JSON form.uv tool install --reinstall --editable ".[mcp]"), its four consequences, and when to preferuvxinstead.uvxreuses an installedoswtool whenever that installation satisfies the specification, so an unpinnedosw[mcp]runs the installed version.Rationale
wikitextwarning fromsrc/osw/wiki_tools.pyappeared on the MCP server's stderr at import time and therefore in every client log. The extra now satisfies the dependency instead of silencing the message.uv tool install "osw[mcp]"putsosw-mcpon PATH, so a client entry can be"command": "osw-mcp"with an emptyargsarray. Changing the version for all servers is then oneuv tool upgrade osw, instead of editing every entry that names--from.Verification
uv run --isolated --no-project --with "osw[mcp]==2.6.2" python -c "import osw.mcp.server"prints the wikitext warning. The same command against this checkout does not.uv run --isolated --no-project --with "osw==2.6.2" osw-mcpfails withModuleNotFoundError: No module named 'mcp'atosw/mcp/server.py:16, which is the behaviour described inindex.md.uvx -vconfirms the reuse caveat: an unpinnedosw[mcp]reportsFound existing environment for tool osw, whileosw[mcp]==2.6.1installs a fresh environment.uv run zensical build -sreports no issues. The anchor#which-command-to-register-for-the-mcp-serverexists in the built HTML and the link fromindex.mdresolves to it.