VegaDūta documentation¶
These pages are also published as a searchable site (mkdocs.yml, make docs-serve); see Publishing these docs.
Start here¶
| Page | For |
|---|---|
| Getting started | Lite install (installer or checkout), first agent, first workflow |
| Installation | Personal (Setup app or CLI), Lite, Full (Docker Compose) and Kubernetes (Helm); images and signature verification |
| Console guide | Every signed-in screen: the Assistant surface, build, channels, monitor, admin |
| Configuration | Spring profiles, core shapes, environment variables, feature flags |
| Extending | Tools from OpenAPI, MCP servers, SKILL.md skills, LLM providers, workflow nodes (NodeHandler, NODE_FORMS), channels (adapter registry), tool sources, the HTTP request pipeline, LLM call sinks, the turn journal |
| SDKs and dependencies | The Java and Python Agent SDKs (governance inside your own application, plus the Java risk scanner) and the generated TypeScript and Python API clients |
| Plugins, apps and mobile | Editor and browser plugins, the Android app, the MCP server: status, catalog, publishing |
| Repository structure | How the repository is arranged and how the platform, public pages, SDKs, docs and plugins are linked |
| Site modes and public pages | Open-source vs commercial public pages, and where every surface is linked |
| Architecture overview | Deployables, data, authentication, and why the chat path stays in one process |
Features¶
| Page | For |
|---|---|
| Personal mode | One person on one machine: the Setup app (installs Docker and a free local model, repairs a failed start) or scripts/vegaduta personal, local sign-in, local models, the Assistant's workspace and desktop tools, skills, sandbox levels, limitations |
| Cost and ROI | Per-agent cost, outcome rates, tenant-entered value assumptions; /roi and /api/tenant/roi/** |
| Running a 30-day pilot, case-study template | The pilot process, baseline, one-page pilot report, demo data (scripts/vegaduta seed-demo) |
| Run free with local models | Ollama in Compose or Helm, the model catalog (scripts/vegaduta models), on-device models at /edge |
| Share an agent as a file | Export an agent as a bundle, import one safely, ready-made examples in examples/agent-bundles/ |
| Edge relay | A signed-in browser as the model behind your SMS and WhatsApp numbers |
| Channels overview | All fifteen channels in one table (how each connects, its endpoint, what you provide), the rules they share, and how each inbound call is authenticated; one page per channel |
| SMS conversations | Plain-text channel on a Twilio number |
| Signal, Matrix, iMessage | Personal channels through a signal-cli server, a Matrix bot user and a BlueBubbles Mac; default deny with pairing |
| WhatsApp QR | Link your own WhatsApp number as a companion device — no Meta Business account, no public URL |
| WhatsApp policy | Meta's rules as read on 2026-10-14 and what the policy guard enforces |
| DPDP obligations and controls | Consent, purposes, retention, export and erasure; engineering notes, not legal advice |
Deploying¶
- deploy/README.md: Compose tiers, profiles, domains and HTTPS, backup, upgrade, troubleshooting
- deploy/helm/README.md: Helm charts, values and validation
- operations/local-stack-guide.md: run it locally, what listens where, and how to see the infrastructure with Docker,
kubectlandk9s - architecture/ADR-cloud-portability.md: which managed services on AWS, Azure and GCP each dependency can use, and what is verified
- architecture/kubernetes.md: Kubernetes design: namespaces, isolation, workload security, scaling, and what is verified
- architecture/HOT-PATH-PERFORMANCE.md: what a chat turn costs the platform before the model is called, the rules that bound it, measured query budgets and what is still unfinished
- deploy/DEPLOYMENT-SHAPES.md: API, jobs and ingest shapes, who runs which scheduled bean, running more than one API replica, autoscaling and the database connection budget
- operations/tunnel-hosting.md: host the Full tier behind a Cloudflare Tunnel with no open ports
Reference¶
- core/mcp/REGISTERING-A-CUSTOM-MCP-SERVER.md: MCP registry API in depth
- connectors/: example OpenAPI connector specs
- architecture/mcp-spec-alignment.md and architecture/a2a-conformance.md: MCP and A2A, requirement by requirement, with what is not done
- architecture/: current design documents: the overview, the generated core module graph, the agents module map (the ten-way split of
core/agents, ADR-0023), ADRs (ADR-0011 provider plugins, ADR-0013 embeddable agent SDK, proposed, ADR-0014 horizontal scaling, ADR-0015 hybrid tenancy, proposed, agent job durability; the proposed, design-only ADR-0016, ADR-0017 and ADR-0018 are in the ADR index; first slices exist for ADR-0019 conformance by construction, ADR-0020 turn journal, ADR-0021 turn inspector and ADR-0022 explicit turn context), the architecture bets (proposed, with status per bet), the structural audit, guardrails, provider modalities, the consumer secrets vault and LLM latency. Where a document disagrees with the code, the code wins. - architecture/archive/: historical design notes from before the repository was published, kept because code comments cite them.
- platform-documentation/: the HTML handbook from the project's
agentic-aiera (architecture, API, security model, development and testing, decision records ADR-0001 to ADR-0010). Legacy: the Markdowndocs/tree is the maintained source and wins where the two disagree; the handbook is kept for the older ADRs. Browse it by openingdocs/platform-documentation/index.htmlin a browser, or serve the folder (python3 -m http.server -d docs/platform-documentation). - adr/: index of every decision record, numbered or not.
- api/: the OpenAPI description (
openapi.json) and the generated TypeScript and Python SDKs. - security-model.md: what taint tracking, the STDIO sandbox and channel pairing do and do not protect against.
- security/authorization.md: roles,
PERM_*permissions, resource grants, conversation ownership, and the tests that keep new endpoints gated. - engineering/: security hardening settings, Flyway versioning, integration tests, characterisation tests, the big-files split plan (status per file), the Error Prone baseline and the standards audit.
- plans/adr/: decision records for work behind feature flags.
- Console engineering notes: web/docs/RUNTIME-CONFIG.md, web/docs/TYPESCRIPT-STRICTNESS.md.
Operating¶
- operations/: backup and restore, upgrade, key rotation, observability.
Maintainers¶
- Repository setup: identity placeholders, repository settings, labels, history
- Branch protection: the required checks (
CI OK,CodeQL OK) and ruleset - Releasing: tags, what a release publishes, signatures, pre-releases and
latest - Dependabot pull requests: the DCO exemption for bots, regenerating
requirements.lockon a Dependabot branch - v1.0.0 definition of done: what 1.0.0 promises and does not, the stability and support rules from 1.0.0, and the release checklist
- Releasing the Java Agent SDK:
sdk-v*tags, Maven Central Portal, GPG, provenance - Publishing these docs: the MkDocs site on GitHub Pages
Project¶
- Contributing · AGENTS.md for AI coding agents
- Roadmap · Changelog
- Governance · Maintainers
- Security policy · Support · Code of Conduct