Skip to content

README.md

Latest commit

 

History

History
42 lines (30 loc) · 1.29 KB

README.md

File metadata and controls

42 lines (30 loc) · 1.29 KB
Raw

DBX Examples

Runnable samples for common DBX workflows.

Directory What it shows
cli/ Terminal queries with @dbx-app/cli
mcp/ MCP configs for Cursor and Claude Code
docker/ Self-hosted Docker deployment
web-api/ Minimal HTTP API automation against DBX Web

Before You Run

  1. Install DBX Desktop, or start the Docker/Web version.
  2. Create at least one connection in DBX.
  3. For CLI examples, install the CLI:
npm install -g @dbx-app/cli
  1. For MCP examples, install the MCP server:
npm install -g @dbx-app/mcp-server

MCP connection access and execution permissions are configured centrally in DBX Settings → MCP. The client examples intentionally contain no permission or connection-scope environment variables.

Suggested Learning Path

  1. Read Getting Started
  2. Try the CLI workflow in cli/basic-workflow.sh
  3. Copy an MCP config from mcp/ into your project
  4. If you self-host DBX, use docker/docker-compose.yml
  5. For custom integrations, inspect web-api/automation.sh

More docs: