One-command install of the full getbased agent stack — getbased-mcp + getbased-rag + getbased-dashboard
Project description
getbased-agent-stack
Meta-package bundling the full getbased agent stack into one install: the MCP adapter, the RAG engine, the browser dashboard, an orchestration CLI (init / install / mcp-config), hardened systemd units for rag + dashboard, and paste-ready configs for Claude Desktop/Code, Cursor, Cline, and Hermes.
Part of the getbased-agents monorepo.
Install
pipx install "getbased-agent-stack[full]"
Pulls:
getbased-mcp— stdio MCP server that Claude Code / Hermes / OpenClaw spawngetbased-rag— local RAG knowledge server (FastAPI + Qdrant + MiniLM/BGE)getbased-dashboard— web UI for library management, MCP config generation, and agent-activity inspection- The
getbased-stackdiscovery CLI [full]extra: PDF/DOCX parsers + ONNX runtime for hardware-accelerated embeddings
Total install: ~500 MB (the ML deps dominate). Smaller installs available — pipx install getbased-mcp (10 MB, agent only), pipx install "getbased-rag[full]" (RAG only), pipx install getbased-dashboard (UI + MCP; pulls rag if you want the Knowledge tab working).
Quickstart — one command
getbased-stack init
The wizard (~30 seconds):
- Prompts for your
GETBASED_TOKEN(skip if you don't use sync) - Generates a rag API key if one doesn't exist
- Writes
~/.config/getbased/env(mode 0600) — the shared config file - Installs systemd user units for rag + dashboard, enables them, starts them
Then paste one line into your MCP client:
getbased-stack mcp-config claude-desktop # or: claude-code, cursor, cline, hermes
The snippet carries only GETBASED_STACK_MANAGED=1 in its env block. No secrets in client configs — every MCP spawn reads the shared env file and loads the token + rag URL + API key path from there.
Open the dashboard:
http://127.0.0.1:8323
Login URL with bearer key:
getbased-dashboard login-url # prints http://127.0.0.1:8323/?key=...
Upload docs, create libraries, manage sources, and test the MCP probe from the web UI. Rotate the sync token from the CLI (see below) or by editing ~/.config/getbased/env directly.
Surviving reboot on headless hosts
User systemd services stop on logout. On a headless server (no GUI session), they won't come back at boot unless you enable linger once:
sudo loginctl enable-linger $USER
getbased-stack init prints this reminder when it detects a headless environment. On a laptop with a GUI login, linger is nice-to-have — services start when you log in.
Other commands
getbased-stack status # env file, unit state, linger
getbased-stack set GETBASED_TOKEN=new # rotate the token
getbased-stack install # re-apply unit files after package upgrade
getbased-stack uninstall # stop + disable + remove units
Migrating from an older install
If you have a hand-rolled setup (standalone lens-rag.service, hermes-style ~/.hermes/config.yaml with MCP env), leave it alone — getbased-stack init only writes new paths and installs new unit names (getbased-rag.service, getbased-dashboard.service), so it can coexist. The opt-in loader in every binary is gated on GETBASED_STACK_MANAGED=1; without that flag set, every binary behaves exactly as before.
If you're running the existing Hermes VM deployment on this host, don't run init there. Your ~/.hermes/config.yaml continues to supply env explicitly; nothing from this package touches it.
Architecture
Claude Code / Hermes / OpenClaw Browser
│ MCP (stdio) │ HTTP
▼ ▼
getbased-mcp getbased-dashboard (localhost:8323)
│ │ │ │
│ HTTP │ HTTP │ proxies │ spawns stdio for Test
▼ ▼ ▼ ▼
sync GW getbased-rag ◀──────────────┘ getbased-mcp
(localhost:8322)
The MCP holds no persistent state; it's a thin translator between MCP tool calls and two HTTP backends:
sync.getbased.health/api/context— read-only lab summary pushed by your PWA session (via Agent Access token)localhost:8322(getbased-rag) — your local research library
The dashboard is likewise stateless — it proxies rag for Knowledge operations, imports getbased_mcp to introspect env/config, and spawns the MCP binary on demand to verify it works.
Version compatibility
| Stack | mcp | rag | dashboard | Protocol |
|---|---|---|---|---|
| 0.1.x | ≥0.2.0 | ≥0.1.0 | — | v1 (multi-library) |
| 0.2.x | ≥0.2.2 | ≥0.6.0 | ≥0.5.0 | v1 (+ streaming ingest, per-library models) |
| 0.4.x | ≥0.2.3 | ≥0.7.1 | ≥0.6.1 | v1 (+ shared env file, getbased-stack init, systemd units) |
Bump the meta's major when sibling protocols break; bump siblings freely for normal features.
Development
This package is the meta — the interesting code lives in sibling packages. See the monorepo root README for workspace setup.
The integration test (tests/test_integration.py) spins up lens serve in a subprocess, ingests a fixture, and exercises every MCP tool round-trip. Catches drift between the siblings the way the v1.21 catch-up drift would have been caught if the test existed then. The dashboard has its own test suite (cd packages/dashboard && uv run pytest) covering the proxy, modal logic, stdio probe, and activity-log handling.
Related docs
- packages/stack/CONTRIBUTING.md — when to bump the meta vs a sibling
- packages/stack/SECURITY.md — threat model, scope, sibling pointers
Licence
GPL-3.0-only, matching the siblings.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file getbased_agent_stack-0.4.0.tar.gz.
File metadata
- Download URL: getbased_agent_stack-0.4.0.tar.gz
- Upload date:
- Size: 28.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86d97339408eb2903f13040488faf4f28d8f828ac4c635e49347821928ad8cbf
|
|
| MD5 |
d273a3250d856b1c99a7fb0f1d3d1025
|
|
| BLAKE2b-256 |
71403d44976700e4cd47d5d9b129a551e8cd55ce9928ae1c79f8649e29c3eb81
|
Provenance
The following attestation bundles were made for getbased_agent_stack-0.4.0.tar.gz:
Publisher:
publish.yml on elkimek/getbased-agents
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
getbased_agent_stack-0.4.0.tar.gz -
Subject digest:
86d97339408eb2903f13040488faf4f28d8f828ac4c635e49347821928ad8cbf - Sigstore transparency entry: 1340654063
- Sigstore integration time:
-
Permalink:
elkimek/getbased-agents@0646896d2074afbd7004589fc037fa432ccb7fe1 -
Branch / Tag:
refs/tags/mcp-v0.2.3 - Owner: https://github.com/elkimek
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0646896d2074afbd7004589fc037fa432ccb7fe1 -
Trigger Event:
push
-
Statement type:
File details
Details for the file getbased_agent_stack-0.4.0-py3-none-any.whl.
File metadata
- Download URL: getbased_agent_stack-0.4.0-py3-none-any.whl
- Upload date:
- Size: 19.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
135d3f153c67409eb8c2dee9a34b2617129a5a034d30621cce9d155ba1e19cf1
|
|
| MD5 |
61cfd86ff1936096c9b298b54f389bda
|
|
| BLAKE2b-256 |
0bf5eaaa705e8b91114cac7e10f72ef40a2303554aeaf1e3dae738793a5ff72c
|
Provenance
The following attestation bundles were made for getbased_agent_stack-0.4.0-py3-none-any.whl:
Publisher:
publish.yml on elkimek/getbased-agents
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
getbased_agent_stack-0.4.0-py3-none-any.whl -
Subject digest:
135d3f153c67409eb8c2dee9a34b2617129a5a034d30621cce9d155ba1e19cf1 - Sigstore transparency entry: 1340654065
- Sigstore integration time:
-
Permalink:
elkimek/getbased-agents@0646896d2074afbd7004589fc037fa432ccb7fe1 -
Branch / Tag:
refs/tags/mcp-v0.2.3 - Owner: https://github.com/elkimek
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@0646896d2074afbd7004589fc037fa432ccb7fe1 -
Trigger Event:
push
-
Statement type: