ember

Official registry Developer tools

Calibrated advice for coding agents: typed questions in, probabilities out. Apple Silicon.

Install

Add this to your client's MCP configuration (Claude Desktop: claude_desktop_config.json; Cursor: .cursor/mcp.json; VS Code and others use the same "mcpServers" shape).

PYPI package ember-advise
Claude Code
claude mcp add ember -e 'EMBER_SERVER_URL=<EMBER_SERVER_URL>' -e 'EMBER_AUTH_TOKEN=<your ember_auth_token>' -- uvx ember-advise==0.16.0 mcp
JSON configuration (Claude Desktop, Cursor, VS Code)
{
    "mcpServers": {
        "ember": {
            "command": "uvx",
            "args": [
                "ember-advise==0.16.0",
                "mcp"
            ],
            "env": {
                "EMBER_SERVER_URL": "<EMBER_SERVER_URL>",
                "EMBER_AUTH_TOKEN": "<your ember_auth_token>"
            }
        }
    }
}

Environment variables

  • EMBER_SERVER_URL Inference endpoint; defaults to the local model server at http://127.0.0.1:8765
  • EMBER_AUTH_TOKEN secret Credential for a remote inference endpoint

Documentation

From the project's README on GitHub, refreshed weekly. Links open on GitHub.

Contents
  1. Ways to run ember
  2. How it works
  3. Verified
  4. Install (Apple Silicon)
  5. Agent onboarding
  6. CLI
  7. Usage
  8. Configuration
  9. Metrics
  10. Development
  11. Tests
  12. Caveats
  13. Troubleshooting
  14. License

A gut feeling for coding agents. AI coding assistants like Claude Code, Codex, opencode, and Kilo Code constantly have to decide: start now or ask a question first? Is this test failure real? Is this change safe to push? ember is a small add-on that gives them a quick second opinion at those moments, as a number ("93% likely this needs review"), so they stop interrupting you needlessly and stop making risky changes without asking. You don't call it yourself; your assistant does. It's free and open source, and you choose where the model runs: on your Apple Silicon Mac (32 GB of memory or more, a one-time ~18 GB download), on a server you host, or on one your team already runs. ember advises; the agent decides.

Under the hood, ember runs Cloudflare's Clef-Flash decision model, from its public Hugging Face repo, and exposes it as one MCP tool, advise, that returns a calibrated probability for every option.

Website: shapeandshare.github.io/ember

Ways to run ember

All three are supported equally; ember init asks which one you want.

On your MacOn a server you hostOn a server someone else runs
Where the model runsyour Apple Silicon Maca Mac or an NVIDIA GPU machine you runwherever its operator runs it
Where your requests gonowhere: they stay on your Macyour serverthat server
What you need32 GB of memory, ~18 GB of diskthe server: as for local, or a CUDA GPU; clients: only its addressits address, and a token if it asks for one
Set up withember model pull, then ember initRemote inference or Hosted deploymentember init --server-url URL

Nothing is ever sent to a server you didn't configure. Without a terminal to ask (a script, CI), ember init sets up local inference; --local or --server-url answer the question up front.

How it works

A decision model is not a chat model: it takes a state plus a schema of typed questions and returns one probability per option, with no text generation. So ember plugs into agents as a tool, while their reasoning stays on their normal LLM:

  • The model server (ember/serving/server.py) loads the model once and stays warm across agent sessions.
  • The MCP server (ember/mcp/mcp_server.py) never loads the model; it starts the model server on the first tool call, so the MCP handshake stays instant.
Names
ThingName
Product, Python import, repositoryember
Distribution (uv tool install, PyPI)ember-advise, because ember is taken on PyPI and gut is held by an empty project
CLIember (short alias: gut; ember-advise too, so uvx ember-advise mcp works)
MCP server / commandember / ember-mcp
Tooladvise — opencode: ember_advise; Claude Code: mcp__ember__advise (plugin: mcp__plugin_ember_ember__advise); Kilo Code: ember_advise
Playbook skill / MCP resourceember-advise / ember://guide
Environment variablesEMBER_*

"Clef" always refers to Cloudflare's upstream model, never to this product. Select a model with ember model pull <name> / EMBER_MODEL=<name>; run ember model list to see every registered entry (flash, full).

A hosted deployment (e.g. Outerbounds) that supplies the model's S3 location directly at start time doesn't use this registry at all — see "Hosted deployment: a model location supplied at start time" below.

Verified

Tested versions and hardware are in COMPATIBILITY.md. Current accuracy and latency, from the latest tracked benchmark run, are on the benchmark report.

Install (Apple Silicon)

Requirements

To use a server someone else runs, you need only Python 3.12 (managed by uv) and the server's address; skip ember model pull. To run the model yourself:

  • Apple Silicon Mac (M-series) on macOS for local use (MPS). Intel Macs remain out of scope. For a hosted deployment on NVIDIA/CUDA compute (e.g. Outerbounds), see "Hosted deployment" below and deployment/README.md.
  • Unified memory above the model's size: 32 GB or more for flash (9B), 96 GB or more for full (27B). Only 128 GB has been verified.
  • Disk: about 18 GiB for flash or 55 GiB for full, in Hugging Face's shared cache (~/.cache/huggingface). Config, state, and logs live in ~/Library/Application Support/ember.
  • Python 3.12, managed by uv.
uv tool install --python 3.12 ember-advise

ember model pull                   # ~18 GB, resumable, disk-space checked
ember doctor                       # platform, dependencies, model, server, and agent registration
ember init --opencode --global     # register with opencode for every repo on this machine

Keep --python 3.12: uv otherwise picks your newest interpreter, which the pinned torch/transformers stack is not tested on.

This installs the latest released wheel from PyPI.

To pin a specific release tag from GitHub instead (no PyPI required):

uv tool install --python 3.12 "ember-advise @ git+https://github.com/shapeandshare/ember@v0.16.0"

The repository is public, so the git install needs no credentials. To use SSH instead, install from git+ssh://git@github.com/shapeandshare/ember@v0.16.0.

If you manage Python with conda, mamba, or pixi, install the same tool from the interim joshburt channel on Anaconda.org (it moves to conda-forge once that feedstock lands):

conda install -c joshburt -c conda-forge ember-advise   # mamba and pixi take the same flags

Installed ember before the rename, as gut? Run uv tool uninstall gut first: both distributions provide the same commands.

Restart opencode and every repo on this machine gains ember_advise. The model server stays lazy — it starts on the first tool call (or with ember start).

Per-project skill and policy (run once in each repo you want ember-aware agents):

cd /path/to/your/repo
ember agents install --agent opencode  # installs the ember-advise playbook skill
ember agents show snippet >> AGENTS.md # then edit the project policy block at the end

The skill teaches the agent when to consult ember and how to ask; the AGENTS.md snippet adds a project-specific policy you customize (e.g. "check change risk before every push"). See Agent onboarding below for all harnesses and options.

flash targets the commit verified on MPS (17f0b0a) and full its release commit (2f3de3d, not yet verified locally) as a download convenience, and torch/torchvision are pinned to the tested minor series — but ember does not restrict itself to a hand-maintained allowlist of individually verified weights; it runs any model that fits its loader contract (constitution Article V, "Model Loading"). Set EMBER_MODEL_DIR to run another weights directory.

Cloud

ember is Apple-Silicon-first locally, and supports NVIDIA GPUs for hosted deployment (constitution Article VI, "Apple Silicon and CUDA") — three devices total: run it on an Apple Silicon host with the memory above (MPS), on an NVIDIA GPU host (EMBER_DEVICE=cuda, float16 — see "Hosted deployment: a model location supplied at start time" and deployment/README.md for a full Outerbounds example), or on any host with the CPU fallback (EMBER_DEVICE=cpu — float32, roughly twice the memory, much slower). The HTTP server binds to loopback by default; to serve other machines set EMBER_HOST and set EMBER_SERVER_AUTH_TOKEN to require Authorization: Bearer <token> (or any header name via EMBER_AUTH_HEADER, e.g. x-api-key, on the client side). Ember does not terminate TLS — front a remote-serving deployment with a proxy. Clients point at it with EMBER_SERVER_URL. See COMPATIBILITY.md and SECURITY.md.

Agent onboarding

Installing the tool is half the job; the other half is making agents want to consult it at the right moments and read its answers sensibly. ember/agent_kit/ ships that guidance through every channel each agent actually reads:

ChannelopencodeKilo CodeClaude CodeCodex CLIHow you get it
MCP server instructions (when to consult, how to ask, how to read answers)✅ in the system prompt✅ in the system prompt✅ (2 KB cap)—built in, nothing to do
ember://guide resource (full playbook)✅ via read_mcp_resource✅ via read_mcp_resource✅—built in
ember-advise skill (playbook, loaded on demand)✅✅✅✅ember agents install --agent <agent>
AGENTS.md / CLAUDE.md policy block✅✅✅ (CLAUDE.md)✅ember agents show snippet >> AGENTS.md
ember init --opencode                  # opencode: config entry, plugin, and skill
ember init --kilocode                  # Kilo Code: kilo.json entry and skill
ember init --codex                     # Codex CLI: .codex/config.toml entry and skill
ember agents install --agent claude    # .claude/skills/ember-advise/SKILL.md
ember agents install --agent codex     # .agents/skills/... (opencode reads this too)
ember agents show snippet >> AGENTS.md # then edit the project policy at the end

The skill is a playbook, not a reference card: the decision points worth consulting ember about, copy-paste question sets for intent and readiness, failure triage, change risk, routing, and effort, and starting confidence thresholds calibrated from observed model output (re-measured whenever the pinned model revision changes). The snippet ends with a project policy — edit it to wire ember into your own workflow, e.g. "check change risk before every push".

Agent-specific notes:

  • opencode reads skills from .opencode/skills, .claude/skills, and .agents/skills, so install one copy per project to avoid duplicate listings.
  • Kilo Code: ember init --kilocode writes the mcp.ember entry to kilo.json (same config shape as opencode) and installs the skill to .kilo/skills/ember-advise/SKILL.md; the tool appears as ember_advise. Kilo Code also reads AGENTS.md automatically.
  • Claude Code: register the server with claude mcp add --scope user ember -- ember-mcp (every project; drop --scope user to register it for the current project only); the tool appears as mcp__ember__advise. Or install the ember plugin, which bundles the MCP entry and the ember-advise skill (so skip ember agents install --agent claude):

    claude plugin marketplace add shapeandshare/ember
    claude plugin install ember@ember

    The plugin still runs the ember-mcp you installed with uv tool install, and its tool appears as mcp__plugin_ember_ember__advise. Use one route, not both, or the tool is listed twice.

  • Codex CLI: ember init --codex writes [mcp_servers.ember] to .codex/config.toml (--global: ~/.codex/config.toml, or $CODEX_HOME/config.toml) and installs the skill to .agents/skills/ember-advise/SKILL.md. Codex loads a project .codex/config.toml only for a trusted project, and ember init --codex tells you whether this one is. The entry forwards EMBER_AUTH_TOKEN by name (env_vars), never by value. Support for MCP server instructions and resources is unconfirmed, so rely on the skill and the AGENTS.md snippet there.
Check what's registered

ember doctor closes with two lines per harness: its binary on PATH, and where ember is registered for it — in this directory and globally — or the command that registers it. It only reads each harness's config files; it never runs a harness CLI.

HarnessRegisterProject scopeGlobal scopedoctor also flags
opencodeember init --opencode [--global]opencode.json, .opencode/plugins/ember.js~/.config/opencode/opencode.json, ~/.config/opencode/plugins/ember.jsa leftover mcp.vault entry from older ember init versions
Kilo Codeember init --kilocode [--global]kilo.json~/.config/kilo/kilo.json—
Codex CLIember init --codex [--global].codex/config.toml~/.codex/config.tomla project file Codex ignores because the project isn't trusted
Claude Codeclaude mcp add --scope user ember -- ember-mcp, or the ember@ember plugin.mcp.json (--scope project); ~/.claude.json per project (--scope local); enabledPlugins in .claude/settings.json / settings.local.json~/.claude.json; enabledPlugins in ~/.claude/settings.jsona project .mcp.json, which Claude Code asks you to approve

Each harness has its own check too: opencode mcp list, codex mcp list, claude mcp list. Older ember init versions also added this repository's vault MCP server to every config they wrote; if you ran ember init --global, doctor points at the leftover entry in your global opencode config so you can delete it.

ember init records the ember-mcp it finds on your PATH, falling back to the Python that runs it, so run ember init --global from the installed tool (uv tool install …) rather than a checkout's .venv. It merges into existing configs and refuses to rewrite one it can't parse (an opencode.json with comments, say), leaving that file untouched.

CLI

gut is a short alias for every command below.

# lifecycle
ember doctor                      # platform, dependencies, model, server, agent registration
ember serve                       # run the model server in the foreground
ember start | stop | restart | status | logs
ember config path | show
ember uninstall [--purge-models]  # also removes global opencode/Kilo Code/Codex and skill installs

# models
ember model pull [flash|full]      # flash = 9B (default)
ember model list | path [name] | rm [name]

# opencode, Kilo Code, Codex CLI, and agents
ember init [--opencode] [--kilocode] [--codex] [--global] [--local | --server-url URL] [--auth-header NAME]
ember agents install [--agent opencode|claude|codex|kilocode] [--global]
ember agents show instructions|skill|snippet
ember mcp                         # the MCP stdio server agents launch

Usage

Ask the agent in natural language — "Is this bug report urgent, and which team should own it?" — and it calls ember_advise with a state and typed questions:

{
  "model": "clef-flash",
  "answers": {
    "urgent": { "type": "noul", "noul": 0.967 },
    "team": {
      "type": "choice",
      "choice": "db",
      "confidence": 0.9782,
      "probabilities": { "db": 0.9782, "frontend": 0.0218 }
    }
  },
  "usage": {
    "input_tokens": 220, "output_tokens": 0,
    "state_tokens": 34, "fixed_tokens": 186, "media_tokens": 0
  },
  "latency_ms": 930.9
}

Question types: noul (yes/no → P(true)), choice (named options), score (ordered options → expected score plus legend). The model field echoes the upstream model label. usage splits input_tokens into the state, the fixed overhead (questions, schema, prompt wrapper), and any media, so a caller can see what each part of a request cost; the benchmark harness requires this split.

When the evidence is visual, attach images or video frames inline: images is a list of data:image/png;base64,... URIs (or {"content_type": "image/png", "base64": "..."} objects), and videos is a list of videos, each a list of frame refs. Remote URLs and local paths are rejected — the model server never reads host files or fetches URLs for an agent.

Configuration

Settings resolve as CLI flag > environment variable > config file > default. The config file is JSON at ember config path (keys model, host, port, device, max_length, server_url, auth_token, auth_header, allow_insecure_transport, request_timeout, server_auth_token, max_request_length; a max_length of 0 means the model's own maximum, and an unset max_request_length means the loaded model's own default cap).

VariableDefaultPurpose
EMBER_HOST / EMBER_PORT127.0.0.1 / 8765Local model server bind address
EMBER_DEVICEautoauto, mps, cuda, or cpu
EMBER_TORCH_DISABLE_NATIVE_JIT1Disables torch 2.14's torch._native Triton-backed op overrides (e.g. a aten::bmm outer-product specialization Qwen3.5's RoPE forward hits on CUDA), which JIT-compile via a C compiler that a minimal CUDA container (e.g. Outerbounds' Fast Bakery) usually lacks — without this, the first real CUDA request fails with RuntimeError: Failed to find C compiler. Set to 0 on a host with a working compiler toolchain to opt back into the (likely faster) Triton path; has no effect on MPS/CPU
EMBER_MODELflashflash (9B, default) or full (27B), both from Cloudflare's public Hugging Face repos
EMBER_MODEL_DIR—Run weights from this directory instead of the pinned cache
EMBER_MAX_LENGTH0 (the model's maximum: 262,144)The most tokens the model processes; 0 derives it from the model's config.json, and a larger value is clamped to it
EMBER_MAX_REQUEST_LENGTHunset: the loaded model's own default, its measured cap or, until measured, its fallback, the longest length that leaves 4 GiB of its memory budget free (24,576 for flash, 65,536 for full). A model outside the registry (EMBER_MODEL_DIR, EMBER_MODEL_S3_URI) gets the lowest registry cap, 24,576 todayPer-request cap on the whole encoded request (state, media, questions, schema, prompt wrapper), checked before inference. A request over it is refused with a 413 that states its token split, never truncated. 0 disables the cap; the maximum still applies
EMBER_SERVER_URLhttp://127.0.0.1:8765Inference endpoint the client sends to; loopback by default, may be remote
EMBER_AUTH_TOKEN—Client credential for a remote endpoint
EMBER_AUTH_HEADERAuthorizationHeader carrying the credential; Authorization sends Bearer <token>, any other name sends the token verbatim
EMBER_ALLOW_INSECURE_TRANSPORT0Allow plaintext http to a non-loopback endpoint (off by default)
EMBER_REQUEST_TIMEOUT900Seconds the MCP client waits for each advise request, local or remote. A request near full's cap takes about 12 minutes on an M4 Max, and requests run one at a time, so raise this if long full requests overlap
EMBER_SERVER_AUTH_TOKEN—When set, the server requires Authorization: Bearer <token> on /v1/systemone
EMBER_AUTOSTART1Let the MCP server start a local server on demand (loopback only)
EMBER_START_TIMEOUT300Seconds to wait for the model server to start
EMBER_STATE_DIRApplication SupportWhere the pid file and logs live
EMBER_MODEL_S3_URI—An s3://bucket/prefix URI naming the exact model location to load — for a deployment (e.g. Outerbounds) that supplies the model's S3 location at start time instead of a REGISTRY key. See "Hosted deployment: a model location supplied at start time" below.
EMBER_S3_ACCESS_KEY_ID / EMBER_S3_SECRET_ACCESS_KEY—AWS credentials for EMBER_MODEL_S3_URI. Optional — when unset, boto3's own default credential chain applies (an IAM role attached to the compute, e.g. Outerbounds; env vars; ~/.aws/credentials). Set explicitly only where no role is attached (e.g. a local developer machine)
EMBER_S3_REGION—AWS region passed to the S3 client

ember doctor and GET /health (engine) report the limits in force and where each came from: the model, a fallback, an operator setting, or a measured default.

Hosted deployment: a model location supplied at start time

Some deployments (e.g. an Outerbounds app) supply the model's S3 location directly at start time, rather than selecting a REGISTRY entry. Set:

export EMBER_MODEL_S3_URI=s3://my-bucket/clef-flash
export EMBER_DEVICE=cuda   # Outerbounds compute is Linux — no MPS; cuda is the GPU path
ember serve                # foreground, container-friendly (not `ember start`)

No AWS credentials need to be set explicitly when the compute already has an IAM role attached (the expected case on Outerbounds) — boto3's default credential chain picks it up automatically. Set EMBER_S3_ACCESS_KEY_ID/_SECRET_ACCESS_KEY explicitly only where no role is attached.

This is checked once at startup, before the server begins serving, and takes priority over EMBER_MODEL/the model config key entirely — there is no REGISTRY lookup for this path. ember supports any model that can run under its loader contract (constitution Article V, "Model Loading"); it is not a hand-maintained allowlist of individually hash-verified weights, so a URI-supplied location loads directly, with no pin or hash to check against.

Complete Outerbounds deployment examples — flash.yaml/full.yaml (one per model, since they need different compute), a generated requirements.txt, and a make deployment-requirements target — live in deployment/.

Remote inference

Run one server and share it: with your team, with CI, or with a second Mac that lacks the memory for the model. Start the server on the host and point each client at it.

On the host machine (the one with the model)
# Bind to all interfaces so other machines can reach it
EMBER_HOST=0.0.0.0 ember start

# Recommended: also require a bearer token so only your client can use it
EMBER_HOST=0.0.0.0 EMBER_SERVER_AUTH_TOKEN=your-secret ember start

Ember does not terminate TLS. On a trusted LAN, plain HTTP is fine (see the client note below). Over the internet, put a TLS proxy (nginx, Caddy) in front and use https://.

On the client machine (the one running the agent)
export EMBER_SERVER_URL="http://<host-ip>:8765"   # use https:// if behind a TLS proxy
export EMBER_AUTH_TOKEN="your-secret"             # matches EMBER_SERVER_AUTH_TOKEN on the host
export EMBER_AUTOSTART=0                          # nothing local to start
ember status                                      # reports remote endpoint + reachability

Plain http to a non-loopback host is refused by default; set EMBER_ALLOW_INSECURE_TRANSPORT=1 to allow it on a trusted LAN. Credentials may also be sent as a custom header (EMBER_AUTH_HEADER=X-API-KEY). ember status / ember doctor report the endpoint kind, reachability, the remote's advertised auth_required, and whether a credential is configured; reverting to local is a single change (unset these variables).

Bootstrapping a client against a hosted endpoint

ember init can generate the mcp.ember entry for a remote endpoint directly, instead of hand-editing the generated opencode.json / kilo.json / .codex/config.toml:

ember init --opencode --kilocode \
  --server-url https://decisions.example.com \
  --auth-header X-API-KEY        # omit for the default Authorization: Bearer header

Run ember init at a terminal without --server-url and it asks for the address instead. Claude Code is registered with its own CLI, so pass the same settings there:

claude mcp add --scope user ember -e EMBER_SERVER_URL=https://ember.example.com -e EMBER_AUTOSTART=0 -- ember-mcp

This writes EMBER_SERVER_URL (and EMBER_AUTH_HEADER, if given) into the config file and forces EMBER_AUTOSTART=0 — there is nothing local to autostart. The credential itself is never written to the file: export EMBER_AUTH_TOKEN in the shell that launches the agent (or your GUI app's environment) instead, so a secret never lands in a config file that might be project-committed. Without --server-url, ember init asks at a terminal and writes a local loopback entry when there is none to ask (or with --local). Restart the harness afterward to pick up the new MCP registration.

This only updates the generated harness config — ember status/ember doctor run directly from your shell still check the local default unless you also export the same EMBER_SERVER_URL/EMBER_AUTH_HEADER/EMBER_AUTH_TOKEN in your shell, or persist server_url/auth_header (never the token) in ember's own config file (ember config path). See deployment/README.md's "Verifying from the shell" for the exact steps and what a healthy response looks like.

Hosted on AWS over Tailscale

make aws-up deploys ember to a single NVIDIA GPU instance on AWS and makes it reachable only over your Tailscale network, with no public ports. The instance runs ember serve with EMBER_DEVICE=cuda and loads weights from a private S3 model cache. Clients connect over HTTPS at the node's MagicDNS name (https://ember-<name>.<tailnet>.ts.net); EMBER_ALLOW_INSECURE_TRANSPORT is never needed.

make aws-tools                        # install the tailscale CLI (macOS: brew; Linux: prints URL)
make aws-cache MODEL=flash            # upload the pinned model to S3 once per region (~18 GiB)
make aws-up                           # deploy; prints the URL and the ember init line
export EMBER_AUTH_TOKEN="$(make -s aws-token)"
ember init --opencode --server-url https://ember-default.<tailnet>.ts.net

ember advises; the agent decides — the deployment changes where the model runs, not how agents call it. See deployment/aws/README.md for prerequisites (AWS quota, Tailscale OAuth client, MagicDNS, HTTPS certificates), costs, every lifecycle command, and teardown.

Metrics

While the model server is running it exposes Prometheus metrics at http://127.0.0.1:8765/metrics (the EMBER_HOST/EMBER_PORT address):

MetricTypeMeaning
ember_advise_requests_total{status}counteradvise requests by HTTP status (200, 413, 422, 503, 500)
ember_advise_latency_secondshistogramadvise request latency by status
ember_advise_input_tokens_totalcounterinput tokens processed
ember_advise_output_tokens_totalcounteroutput tokens produced
ember_model_info{model,device,dtype}gauge1 while a model is loaded

The endpoint binds to the same address as the rest of the API (loopback by default), so it is reachable only there unless you change EMBER_HOST. Ember's metrics live in a dedicated Prometheus registry, so the standard python_*/process_* collectors are not included — /metrics shows only the table above.

Development

ember/
  cli.py              # the `ember` command (alias `gut`): argparse wiring + main()
  commands/           # subcommand handlers: lifecycle, doctor, models, agents, eval, config
  models.py           # pinned model registry + pull/list/rm
  serving/            # HTTP model server, MPS runtime, lifecycle, media
    server.py         #   FastAPI: POST /v1/systemone, GET /health (reports pid)
    runtime.py        #   MPS-safe loader (CPU load → .to("mps")) + Engine
    process.py        #   model-server lifecycle (pid file + HTTP health)
    media.py          #   base64 data-URI / {content_type,base64} → PIL decoder
  mcp/                # MCP stdio server and wire types
    mcp_server.py     #   MCP stdio server: advise tool, instructions, ember://guide
    mcp_types.py      #   Pydantic wire types (Question, AdviseInput)
  cfg/                # configuration, endpoint, and platform paths
    config.py         #   config resolution (CLI flag > env > file > default)
    endpoint.py       #   client endpoint: loopback check, transport guard, auth headers
    paths.py          #   platform-aware app dirs (macOS Library, XDG)
    repo_root.py      #   checkout / main-worktree root from .git on disk
  opencode/           # opencode integration
    opencode_config.py  # generates opencode.json
    opencode_plugin.py  # installs the npm plugin
  kilocode/           # Kilo Code integration: generates kilo.json
  codex/              # Codex CLI integration: .codex/config.toml entry, project trust
  claude/             # Claude Code registration detection (read-only)
  agent_kit/          # what agents read: instructions, ember-advise skill, AGENTS snippet
    api.py            #   public API: instructions(), skill(), snippet(), install_skill()
packages/opencode-plugin/   # opencode plugin source (unpublished; `ember init --opencode` writes the installed copy)
packages/claude-plugin/     # Claude Code plugin (MCP entry + mirrored ember-advise skill), listed by .claude-plugin/marketplace.json
server.json                 # MCP Registry entry (io.github.shapeandshare/ember), published by release-ember.yml
scripts/              # make-only dev tools: MPS smoke, MCP e2e, site build, provenance/vault audits
evals/eval/           # benchmark harness: run, report, export, snapshot, agent-in-the-loop
tests/                # pytest suite (unit + model-backed, host-isolated)
vault/                # project memory (Obsidian): decisions, discoveries, session logs
.specify/             # spec-kit; memory/constitution.md governs this repo
AGENTS.md CLAUDE.md   # guidelines for agents working on this repo
Makefile              # contributor lifecycle (wraps the CLI)
make bootstrap    # deps + pinned weights + opencode.json + doctor (idempotent)
make start        # model server in the background; stop | restart | status | logs
make opencode     # this checkout's opencode plugin and skill

opencode.json, .opencode/plugins/ember.js, and .opencode/skills/ember-advise/ (like kilo.json, .codex/config.toml, and the other harnesses' ember-advise skill copies) embed this clone's absolute paths or copy packaged files, so they are gitignored — regenerate them with make init / make opencode after cloning. .opencode/opencode.json is shared and committed: it registers the vault MCP server that agents use to read and write vault/ (launch opencode from the repository root).

Make targets
TargetWhat it does
make helpList all targets (default)
make bootstrapFrom a fresh clone: setup + download + init + doctor
make setup / sync / downloadDeps only / deps only (alias) / pinned weights to .models/
make init / make opencodeember init / ember init --opencode for this checkout
make serve / start / stop / restart / status / logsModel-server lifecycle via the CLI
make mcp / make mcp-listRun the MCP server / opencode mcp list
make test / test-fast / test-strictFull suite / unit tests only / full suite that fails without weights
make test-evalsCalibration eval suite: positive + negative recipe cases (loads model)
make eval-runRun the benchmark dataset against the live server; writes results/
make eval-snapshotCopy the latest run into benchmark/ for the site to render
make eval-contextLong-context probe: measure each model's request cap on MPS (hours)
make eval-context-smokeLong-context probe smoke: flash, 2K and 4K, 3 items (minutes)
make eval-reportRender the most recent run as a Markdown table
make dataset-lint / dataset-cardLint the benchmark dataset (report mode; no-live-secret enforced) / regenerate evals/dataset/card.json + CARD.md
make audit-sourcesRe-check every data-source register row online (before a dataset publication)
make mcp-check / make smokeMCP end-to-end check / direct MPS inference
make compile / make checkByte-compile / compile + unit tests
make cibootstrap + check + test-strict
make doctorember doctor
make vault-auditCheck vault/ notes: frontmatter, tags, wikilinks, code-refs, orphans
make site / make site-serveBuild the Pages site into site/_site / preview it at :4000, rebuilt and reloaded in the browser on every edit (needs Docker)
make aws-tools / aws-tools-rmInstall / remove the tailscale CLI (macOS: brew; Linux: prints URL)
make aws-preflightCheck AWS identity, quota, Tailscale OAuth, and MagicDNS before creating anything
make aws-cacheCreate the S3 model cache stack (if absent) and upload the pinned model
make aws-cache-list / aws-cache-rmList cached models / remove one cached revision
make aws-cache-destroyDelete the cache bucket (requires CONFIRM=<bucket>; refused while deployments exist)
make aws-upDeploy (or update) the ember GPU instance and wait for health
make aws-statusShow deployment state, instance, tailnet URL, health, and cost estimate
make aws-stop / aws-startStop / start the EC2 instance
make aws-replaceReplace the instance with the latest DLAMI and wait for health
make aws-logsStream instance logs via Tailscale SSH (`UNIT=ember\converge\idle\tailscale`)
make aws-sshOpen a Tailscale SSH shell on the instance
make aws-tokenPrint the server auth token
make aws-rotate-tokenGenerate a new server token and reboot the instance
make aws-downDestroy the deployment (requires CONFIRM=<name>; keeps the S3 cache)
make aws-verifyRun the CUDA verification gate over Tailscale SSH and benchmark from here
make release-dryPreview the next ember version bump without changes
make release-emberTrigger the release workflow on main (bump PR → GitHub Release → PyPI)
make clean / make clean-modelCaches and build output / weights (EMBER_FORCE=1 skips the prompt)

Make re-syncs the environment automatically when pyproject.toml or uv.lock changes.

Tests

make test         # full suite (~30 s, loads the model once)
make test-fast    # unit tests only, no model load (~12 s)
make check        # compile + test-fast
make test-strict  # full suite; fails (not skips) if weights are missing
make ci           # bootstrap + check + test-strict

tests/ covers the supported call paths:

  • GET /health and POST /v1/systemone across noul / choice / score, probability normalization, and request-validation 422s
  • MCP tool discovery, advise over stdio, actionable errors (server down, model missing, malformed questions), and autostart on a configured port with pid cleanup
  • the agent kit: instructions size, skill frontmatter, the ember://guide resource
  • the CLI: agents, init --opencode, status/stop on unused ports, doctor, uninstall
  • process safety: stop never signals a pid that is not an ember server it started

Safe on a host running other opencode instances. The suite binds random free ports (never 8765), keeps state in temporary directories, stops only the processes it started, and never invokes the opencode CLI or touches global opencode config.

CI (.github/workflows/ci.yml) runs uv sync --locked and then, as separate jobs, format and lint, mypy --strict, bandit, make check, uv build plus an install smoke of the built wheel on a hosted Apple Silicon runner, a SonarCloud scan (needs the SONAR_TOKEN repository secret), and a zizmor audit of the workflows. Model-backed tests are not run in CI: the ~19 GB fp16 model does not fit the available runners (hosted or the org's 8 GiB self-hosted VMs), so run make test locally for model-affecting changes.

Coverage is tracked and gated (constitution Article XI). Run make test-cov to see the full report. The enforced floor (fail_under in pyproject.toml) is the current measured level and may only increase — currently 94 %. Lowering it requires explicit, recorded approval per Article XI §11.2.

Benchmark

evals/clef-flash.jsonl is the benchmark. It covers the five agent-kit recipes (intent and readiness, failure triage, change risk, routing, effort and approach), two mined recipes from the maintainer's vault (tag_assignment, note_placement), plus four vision recipes (vision_noul, vision_choice, vision_score, vision_video), with every item in a dev or test split; the benchmark report gives the current item and question counts. Vision items carry an images or videos field (base64 data: URIs) alongside state and questions. Each line is self-contained (state, the recipe's fixed question set, a gold label for every question, a rationale, and a structured source), so other implementations can score it without this harness.

Every item says where it came from: source.kind is one of authored (written for the benchmark), mined (a public record, named by its register row), captured (a real session, with consent), perturbed (a controlled variant of a parent_id), templated, drafted (model-drafted, then reviewed), or imported (an external dataset under its licence). Public sources are tracked in the data-source register (evals/dataset/register.json: licence reading, snapshot, mirror, verdict); make audit-sources re-checks every row online before a dataset publication, and nothing is imported without a register row that allows it.

make eval-run              # or: ember eval run [--split dev|test] [--category <recipe>] [--resume]
make eval-report           # Markdown report of the most recent run
make eval-export           # or: ember eval export; the reviewer bundle described below
make eval-snapshot         # or: ember eval snapshot [--rebuild]; copy a run into benchmark/
make dataset-lint          # or: ember eval dataset lint [--dataset PATH]
make dataset-card          # or: ember eval dataset card [--check]; the data card
ember eval dataset hash    # content, file, per-recipe, and register hashes
ember eval dataset check   # provenance check: every item's source and register row
ember eval report --compare results/<a>_results.json results/<b>_results.json

The dataset has two hashes. The content hash covers what is scored (id, category, split, state, media, questions, gold labels) and is the dataset's version: annotations such as the item kind, tier, source, or rationale never change it, while a gold label, a state, a question, or a split does. The file hash covers the bytes, for provenance. Every run records both, plus a hash per recipe, and the leaderboard shows one table per content hash, newest first; results on different versions are never compared. Within a table, one row per model, deployment, and engine settings, with one column per recipe: a re-run of a single recipe (--category) refreshes just that column, and the headline appears once every decision recipe has been scored on that version. Vision recipes are reported separately as a capability panel, never in the headline. splits.lock pins every item's split for good, versions.lock records every dataset version ever published (and each protocol rule and scale names the version it first applies to), and each release's changelog carries a Benchmark dataset: <content hash> line naming the version it was measured on.

Phase 1 of the benchmark programme adds hygiene. The risk and effort recipes carry rubric anchors at every level and publish a label-stability measurement from a blinded re-label round — single-rater, and the report says so. The same dataset runs at float16 on MPS and on a CUDA deployment as one controlled comparison, committed as a pair of bundles with a build gate. Every item carries a kind and a difficulty tier (annotations that never change the dataset version), and the report separates non-easy accuracy. Every leaderboard row carries its long-context shape — request cap, first-drop length, worst depth — or says "not measured" until a probe run exists. Real agent sessions can become candidate items through ember eval capture import, which refuses any session without a redaction record or with a surviving secret; the model is never used to label.

A run can be interrupted and resumed (ember eval run --resume) as long as the dataset version, recipes, model, and settings match its manifest; ember eval snapshot --rebuild re-renders an existing bundle from its stored trace after the report code changes, without re-running the model. The harness needs a server that reports the token split in usage (ember 0.12.0 or later) and records it per item.

ember eval export writes results/<run_id>_report/ for external reviewers: report.html (one self-contained file with inline charts, light and dark themes, a print layout, and item filters; it loads nothing from the network), report.md with its figures/*.svg, and data/ with the run's results, trace, and the exact dataset scored. The report covers context, the system under test, benchmark design, metric definitions with references, results, calibration, the agent kit's decision rules replayed on every item, a review card for every miss, limitations, and reproduction pins.

The report gives accuracy with a 95% bootstrap interval, macro-F1, top-label ECE, and Brier score (choice, noul); ranked probability score and MAE (score); coverage and accuracy at the agent kit's act-on-it thresholds; dangerous-option recall for the risk recipe; accuracy by source kind and by item tier; consistency across perturbed variants of the same parent; and the token split (state, fixed, media) per request. Each run records the git hash, the engine and its settings, and the dataset's hashes, and --compare warns when two runs scored different item sets.

Gold labels are judged from state alone against the recipe's option descriptions, and they are fixed before any run: needs_review is true exactly when risk is Medium or High, and retry only for flaky failures. A person reviews disagreements; labels are never changed to match the model. make check validates the dataset (tests/test_eval_benchmark.py), and the dataset lint reports gaps against each recipe's design (option balance, leakage between splits, near-duplicates); its one enforced rule, no-live-secret, fails on anything that looks like a real credential. ember eval reads evals/ and scripts/ from the checkout, so it works only in a clone.

Long-context probe

make eval-context (or ember eval context) measures how each registered model holds up as requests grow: it pads every text-only benchmark item with public-domain filler to 2K–64K tokens, with the evidence at the start, middle, or end, and records accuracy, calibration, peak MPS memory, and latency. A pre-declared rule then picks each model's default cap: the longest length where accuracy stays within 2 points and Brier within 0.02 of the 2K result at every depth, and peak memory fits 32 GB (flash) or 96 GB (full). It runs in-process on MPS for hours, never touches a running server, and writes results/context/<run_id>/; the run a decision cites is copied into evals/context/runs/ with --snapshot. --rescore rebuilds the summary byte for byte, and --reproduce re-runs a run's pinned inputs and compares them.

Agent in the loop

The benchmark above scores the model. ember eval agent scores ember the way it is used: through a coding agent. It gives opencode 54 scripted requests (vague and precise asks, failing tests, risky and trivial commits, routing and effort questions, and controls), each in a throwaway git repo, and judges the agent only by what it did (files, commits, tests, its reply). Each scenario runs under four conditions: none (no ember), mcp (the MCP server and its instructions), skill (plus the ember-advise skill), and full (plus the AGENTS.md policy).

ember start                       # the agent sessions call the warm server
make eval-agent-smoke             # 6 scenarios x 4 conditions x 2 models, 1 trial
make eval-agent                   # or: ember eval agent [--models ...] [--trials 3] [--parallel 8]
ember eval export --agent latest  # put the agent results first in the reviewer report

Every session runs opencode run --pure with a private HOME and XDG directories and no TCP port, so your opencode config, plugins, sessions, and running instances are untouched. The provider key is read from the environment or opencode's auth file and passed only to the child process. The run reports, per model and condition: gold-action accuracy, its paired change against none, how often the agent consulted ember at decision points (and on controls), whether it consulted before acting, asked the kit's recipe questions, passed the evidence, and followed ember's answer, plus cost and time per session. It spends real provider credit and is never part of make check, make test, or CI.

Caveats

  • Gated DeltaNet fallback. Qwen3.5's backbone is a hybrid linear-attention model. The optimized CUDA kernels (causal_conv1d, flash-linear-attention) don't exist for Apple Silicon, so it uses the pure-PyTorch reference path: correct but slower. You'll see two "falling back" log lines — expected.
  • fp16 on MPS. bfloat16 works but is emulated and less battle-tested on MPS, so the loader uses float16; CPU mode uses float32.
  • Vision works on MPS. Images and video frames run through the same fp16 path as text. Inline them as base64 data: URIs in images/videos; remote URLs and local paths are rejected on purpose, so an agent cannot make the server read host files or fetch URLs. Text-only inputs skip the vision tower entirely.
  • Numerics. MPS can differ slightly from CUDA/CPU. If calibrated probabilities matter, cross-check with EMBER_DEVICE=cpu ember restart.
  • device_map={"": "mps"} segfaults with the pinned stack. The loader loads on CPU and then moves the model to MPS — don't "simplify" that away.

Troubleshooting

  • Start with ember doctor, then ember logs (~/Library/Application Support/ember/logs/server.log).
  • The agent can't see the tool: ember doctor shows where ember is registered for each harness (and flags an untrusted Codex project or a Claude Code .mcp.json awaiting approval); opencode mcp list should show ✓ ember connected.
  • "model … is not pulled": run ember model pull, or point EMBER_MODEL_DIR at the weights.
  • Qwen3VLVideoProcessor requires Torchvision → torchvision is a pinned dependency; run uv sync (or reinstall the tool).
  • Any single unimplemented MPS op falls back to CPU (PYTORCH_ENABLE_MPS_FALLBACK=1, set by the runtime).

License

MIT (see LICENSE). Cloudflare's Clef weights and joint_schema_model.py are Apache-2.0; they are downloaded from Hugging Face at runtime, not redistributed here.


Brand assets and palette · Provenance and licensing · Project site

Frequently asked questions

What is ember?

Calibrated advice for coding agents: typed questions in, probabilities out. Apple Silicon.

How do I install ember?

It runs on your machine. In Claude Code: claude mcp add ember -e 'EMBER_SERVER_URL=<EMBER_SERVER_URL>' -e 'EMBER_AUTH_TOKEN=<your ember_auth_token>' -- uvx ember-advise==0.16.0 mcp. For other clients, paste the JSON configuration from this page into their MCP settings.

Does ember need an API key?

Yes. It expects EMBER_AUTH_TOKEN, which you set in its configuration.

Is ember open source?

Yes. Its code is on GitHub under the MIT license.

Who maintains ember?

It is published by shapeandshare. AI.tn lists it but does not maintain or endorse it.

From the official MCP Registry. Listing is not an endorsement: review a server's code and permissions before giving it access to your data.