Skip to content

feat: an osw CLI and an MCP server for live OSL instances #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LukasGold wants to merge 40 commits into
base: main
Choose a base branch
from
Open

feat: an osw CLI and an MCP server for live OSL instances #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
23db777
feat(mcp): add osw-mcp server exposing a live OSL instance
LukasGold Jul 16, 2026
e219aae
feat(mcp): port server to mcp 2.x and isolate the extra
LukasGold Aug 22, 2026
a7c35a7
feat(mcp): authenticate from an osw credential file
LukasGold Aug 22, 2026
d393a66
feat(mcp): select between multiple OSL instances at runtime
LukasGold Aug 22, 2026
ec54bcd
refactor: extract SDK-free osw.service core from osw.mcp
LukasGold Aug 25, 2026
431f33f
refactor(service): lift search tools into osw.service.ops
LukasGold Aug 25, 2026
1959876
refactor(service): lift remaining tool bodies into osw.service.ops
LukasGold Aug 25, 2026
c1cede3
feat(cli): add typer CLI assembled from the operation registry
LukasGold Aug 25, 2026
4ed8c7c
feat: remove filesystem paths from the MCP surface
LukasGold Aug 25, 2026
cb7d807
feat(mcp): pin one instance per server, wire annotations and meta
LukasGold Aug 25, 2026
b6fc0c0
refactor(mcp): drop tool closures, fold registration into server
LukasGold Aug 26, 2026
c3ee9de
build: type-check src/osw/mcp instead of excluding it
LukasGold Aug 26, 2026
cf21923
docs: document the osw CLI and unify the config reference
LukasGold Aug 26, 2026
085db4a
fix(config): find .env from the CWD, report config sources
LukasGold Aug 26, 2026
1070646
docs: move CLI and MCP sections out of the README
LukasGold Aug 27, 2026
a1ef49a
docs: default MCP examples to a credential file in env
LukasGold Aug 27, 2026
cd17247
feat(mcp): require an explicitly configured OSW_DOMAIN
LukasGold Aug 27, 2026
3d91d92
docs: restructure the CLI and MCP guide
LukasGold Aug 28, 2026
3a41c48
docs: simplify the CLI and MCP setup section
LukasGold Aug 28, 2026
84b69e9
added local folders to .gitignore
LukasGold Aug 28, 2026
951a66e
docs: correct why the CLI may infer an instance
LukasGold Aug 28, 2026
c1ef65e
Merge origin/main into feat/mcp-server
LukasGold Aug 28, 2026
8f81fec
refactor: de-isolate the mcp extra from the dev environment
LukasGold Aug 28, 2026
be75e47
docs: drop remaining references to the separate MCP environment
LukasGold Aug 28, 2026
64d99d6
fix: allow uploading a file from an in-memory stream
LukasGold Aug 28, 2026
2051c26
refactor(service): validate Settings with pydantic
LukasGold Aug 28, 2026
4a933af
Merge fix/in-memory-file-upload into feat/mcp-server
LukasGold Aug 28, 2026
4b7dd7e
test: stop test_init_from_env_vars leaking OSW_CRED_FILEPATH
LukasGold Aug 28, 2026
f4ef72c
test: do not assume the first ask-query hit carries jsondata
LukasGold Aug 28, 2026
56711ed
fix(service): validate read_only via pydantic instead of truthy set
LukasGold Aug 31, 2026
422d872
fix(deps): make python-dotenv a base dependency
LukasGold Sep 4, 2026
97b950a
feat(cli): find accounts.pwd.yaml in the working directory
LukasGold Sep 4, 2026
7d77397
feat(cli): print one configuration line by default
LukasGold Sep 4, 2026
568205b
docs(mcp): add a quick install section for claude mcp add
LukasGold Sep 4, 2026
e57eb1f
docs(cli): make the search help explain OSW-ID titles
LukasGold Sep 4, 2026
c7306a9
feat(search): add a page-content search
LukasGold Sep 4, 2026
38a49ea
docs(cli): rename `search text` to `search titles`
LukasGold Sep 4, 2026
4e70ab9
docs(mcp): describe the credential lookup without the rationale
LukasGold Sep 4, 2026
2b66474
feat(mcp): report config sources only when OSW_VERBOSE is set
LukasGold Sep 4, 2026
a3f5eec
test(mcp): cover main() on a successful start, quiet and verbose
LukasGold Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,8 @@ playground
/osw_files/
*/accounts.pwd.yaml
/accounts.pwd.yaml
.ign
.claude

# Local folders
.ign/
.claude/
graphify-out/
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pip install osw
```

Optional extras (`osw[wikitext]`, `osw[DB]`, `osw[S3]`, `osw[dataimport]`,
`osw[UI]`, `osw[all]`) are described in the
`osw[UI]`, `osw[mcp]`, `osw[all]`) are described in the
[Get Started guide](https://opensemanticlab.github.io/osw-python/get-started/).

## Quickstart
Expand All @@ -39,6 +39,19 @@ More runnable scripts live in [examples/](examples/), and the
[Basics tutorial](docs/tutorials/basics.ipynb) walks through the
OpenSemanticLab data model.

## CLI and MCP tools

Installing `osw` also installs an `osw` command line client, and the
`osw[mcp]` extra adds an MCP server that exposes a live instance to agent
clients such as Claude Code:

```bash
osw search ask '[[Category:Item]]' --limit 5
```

Commands, tools and their configuration are described in the
[CLI and MCP guide](https://opensemanticlab.github.io/osw-python/cli-and-mcp/).

## Contributing

Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down
Loading