Quickstart

Get NimbleBrain running locally with Docker Compose. You need Docker and an Anthropic API key.

Create a config file

Create nimblebrain.json in a new directory:
nimblebrain.json
```
{
  "$schema": "https://schemas.nimblebrain.ai/v1/nimblebrain-config.schema.json",
  "version": "1"
}
```
Both $schema and version are part of the config. This minimal file starts NimbleBrain with no MCP apps installed. The agent still has built-in platform capabilities (conversations, files, tasks, skills, usage). You install apps from the web UI in step 5 to give it domain-specific tools.

Apps are not listed in nimblebrain.json. Per-workspace app installs live in workspace.json, which the runtime manages for you. The config file is for runtime settings (model, limits, features), not app inventory.

Create instance.json beside it. It names the identity provider, and the platform does not start without it. The dev adapter signs every request in as one local developer, with no login:
instance.json
```
{
  "auth": {
    "adapter": "dev"
  }
}
```

Create a Docker Compose file

services:
  platform:
    image: ghcr.io/nimblebraininc/nimblebrain:latest
    restart: unless-stopped
    volumes:
      - workspace:/data
      - ./nimblebrain.json:/data/nimblebrain.json:ro
      - ./instance.json:/data/instance.json:ro
    environment:
      - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}
    networks:
      - internal

  web:
    image: ghcr.io/nimblebraininc/nimblebrain-web:latest
    restart: unless-stopped
    ports:
      - "27246:8080"
    environment:
      - PLATFORM_URL=http://platform:27247
    depends_on:
      platform:
        condition: service_healthy
    networks:
      - internal

volumes:
  workspace:

networks:
  internal:

The platform image runs the agent API on port 27247 (internal). The web image serves the UI and is published on port 27246.

Set your API key and start
Terminal window
```
export ANTHROPIC_API_KEY=sk-ant-api03-...
docker compose up
```
You should see output like:
```
✔ Container quickstart-platform-1  Healthy
✔ Container quickstart-web-1       Started
```
The platform container reports healthy once http://localhost:27247/v1/health responds (checked internally). The web container then starts.
Open the web UI

Go to http://localhost:27246.

There is no login screen: the dev adapter in instance.json makes you a single built-in user. This is the right setup for trying things out locally.

The dev adapter checks no credential. Before exposing NimbleBrain to a network, switch instance.json to a real adapter (oidc or workos). See instance.json.

Try sending a message:
```
What can you help me with?
```
The agent responds using its built-in platform capabilities. To give it domain-specific tools, install an app in the next step.
Install a connector

A connector is a remote MCP server the platform connects to. Open the connectors catalog from workspace settings to browse and install one in the UI, with point-and-click OAuth.

The agent can search the catalog for you, though installing happens in the UI:
```
Which connectors could help me work with my calendar?
```
Once a connector is connected, its tools join the agent’s namespace. Ask the agent to use them in plain language.

What’s next

InstallationAll install methods: Docker Compose or from source, plus auth setup

Core ConceptsUnderstand the agent loop, connectors, skills, and tools

ConnectorsBrowse the catalog and connect a remote MCP server