Skip to main content

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 --include-deps "getbased-agent-stack[full]"

The --include-deps flag is required — it exposes getbased-mcp, lens, and getbased-dashboard alongside getbased-stack on your PATH. Without it, pipx only links the stack's own entry point and the MCP/rag/dashboard binaries stay hidden inside the venv.

uv users: install each package as its own tool instead, since uv tool has no --include-deps equivalent yet:

uv tool install getbased-mcp
uv tool install "getbased-rag[full]"
uv tool install getbased-dashboard
uv tool install "getbased-agent-stack[full]"

Pulls:

  • getbased-mcp — stdio MCP server that Claude Code / Hermes / OpenClaw spawn
  • getbased-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-stack discovery 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):

  1. Prompts for your GETBASED_TOKEN (skip if you don't use sync)
  2. Generates a rag API key if one doesn't exist
  3. Writes ~/.config/getbased/env (mode 0600) — the shared config file
  4. 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 alonegetbased-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

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

getbased_agent_stack-0.5.1.tar.gz (32.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

getbased_agent_stack-0.5.1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file getbased_agent_stack-0.5.1.tar.gz.

File metadata

  • Download URL: getbased_agent_stack-0.5.1.tar.gz
  • Upload date:
  • Size: 32.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for getbased_agent_stack-0.5.1.tar.gz
Algorithm Hash digest
SHA256 16eaac6ab29c36a9e6fe4a1974fb0026ddec86072e0d5199d5df77b38d978ad0
MD5 b07432bc065d7f042b18908756f3b407
BLAKE2b-256 f74e991ef8a1751b038411d2207d9e47e962373fd450ae90e538a5c75db32fb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for getbased_agent_stack-0.5.1.tar.gz:

Publisher: publish.yml on elkimek/getbased-agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file getbased_agent_stack-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for getbased_agent_stack-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 398f73d160757837adc7cafbf9cb6f9299af0d3bc0995eeaf2ed0ef6da18b571
MD5 4d8cfba53ef3f58de00467117ff0204d
BLAKE2b-256 dda66fcfd988efcb21cf997c598c5384e470dd609b170a46095321887c6be50c

See more details on using hashes here.

Provenance

The following attestation bundles were made for getbased_agent_stack-0.5.1-py3-none-any.whl:

Publisher: publish.yml on elkimek/getbased-agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page