MongrelDB Viewer documentation
July 28, 2026 · View on GitHub
MongrelDB Viewer is a desktop client for exploring and operating an open MongrelDB database. These guides cover installation, every UI surface, Agent and MCP integrations, data persistence, security, troubleshooting, and repository architecture.
Start
| Guide | Use it for |
|---|---|
| Installation and builds | Release packages, source prerequisites, development, bundles, model cache, upgrades |
| First launch and demo | Create the demo, learn navigation, run the first queries |
| Connection modes | Direct locks and credentials, Server auth and limitations, recents, disconnect |
Fast path:
git clone https://github.com/visorcraft/MongrelDB-Viewer.git
cd MongrelDB-Viewer
npm ci
npm run tauri dev
Choose an empty directory and click Create demo DB.
Use every surface
| Surface | Guide | Main operations |
|---|---|---|
| Deck | Overview | Counts, capabilities, insights, recipes, refresh |
| Stars | Schema map | Graph nodes, edges, pan, zoom, mode differences |
| Table | Table browser | Columns, flags, indexes, row samples, REINDEX |
| SQL | SQL workbench | Execution, caps, history, recipes, result conversion |
| ANN | Vector search | Install, rebuild, backfill, algorithms, scoring, provenance |
| Agent | Agent chat | Endpoint contract, memory-only key, tool loop, safety, troubleshooting |
| MCP | MCP bridge | HTTP, stdio, protocol methods, every tool and argument |
| About | Licenses and credits | Offline legal documents and regeneration |
Operate safely
| Guide | Contents |
|---|---|
| Configuration, local data, and troubleshooting | Persistent keys, cache/config paths, environment variables, ports, network activity, errors |
| Security policy | Private reporting, supported versions, trust model, credentials, Agent and MCP risks |
Important defaults:
- Direct mode is exclusive and read-write.
- SQL is not restricted to
SELECT. - Agent and MCP can run mutating tools without a separate confirmation.
- Agent Save persists URL/model settings, never the API key.
- In-app MCP is unauthenticated and bound by the UI to
127.0.0.1. - Semantic search is table-scoped, not database-wide.
Understand and contribute
| Guide | Contents |
|---|---|
| Architecture | Layers, state, request flows, source map, trust boundaries, internal/public interfaces |
| Contributing | Fork workflow, development gate, tests, dependency/legal updates, release checklist |
| Compatibility fixture | Frozen older root and deliberate regeneration |
Reference map
Need to install? installation.md
Cannot connect? connections.md, then operations.md
Need SQL examples? sql.md
Need semantic search? ann.md
Connecting an AI client? mcp.md
Using an in-app model? agent.md
Investigating local secrets? operations.md and SECURITY.md
Changing code? architecture.md and CONTRIBUTING.md
Project: GitHub · Engine: MongrelDB · Product: mongreldb.com