Project Brain

  1. › opening Project Brain
  2. › synthetic demo
  3. › loading workspace
Skip to content
Project Brainmemory for your AI agents

Workspace

DashboardProjectsMemoryQualityActivitySettingsSetup

Read-only example → install your own

Demo dataNumbers are examples until the API is connected.

Help

Workspace/Help

Across all projects
Demo data · synthetic examples

Read-only preview. No repository or model is connected; the numbers and project knowledge are examples.

Install your own →

Loading this screen…

Help

What Brain is, answers to common problems, and the words this dashboard uses. Each entry links to the screen or guide that goes deeper.

About Brain

Project Brain reads the committed source of your repositories and gives your coding agents context through MCP: the relevant code, the decisions and rules you recorded, and what a change may affect. It runs on your own server, for one operator or a small team whose members each see only the projects they have a role on. It is early software; run it for people you trust.

Version
Demo data — not connected to a Brain server
Source
GitHub · Releases · Report a problem · MIT License

Common questions

Problems people run into first, and where to fix them.

My agent isn’t using Brain

Connecting Brain makes its tools available; it doesn’t make an agent call them. Check that the agent is connected in Setup, then ask it in its instructions to call prepare_task_context before planning a change and review_diff before finishing.

MCP calls appear under Activity, and prepared task context appears under Context packs. Agent tasks only lists work explicitly started through the harness. See the suggested agent workflow.

Brain says it is behind the code

Brain answers from the last commit it read. Press Ctrl K and choose “Re-index the repository” (on a team this needs a Contributor or Reviewer role on the project), or use the index step in Setup (team admins). Later runs only re-read what changed.

Brain reads committed source only. If a re-index refuses the repository, commit your source edits first; ignored build output such as node_modules doesn’t count. Past runs are under Index runs.

A job is queued and never finishes

Jobs run in a background worker, not in the API. For a source checkout, ./scripts/start.sh starts the API, worker and dashboard. For a Docker server, use ./deploy/server_up.sh and follow the deployment runbook rather than starting a second local stack.

Activity shows each job and where it stopped.

The dashboard shows example numbers

The dashboard isn’t connected to a Brain server, so it shows demo data. Start Brain with ./scripts/start.sh; it gives the dashboard the server address and key. A web app started on its own stays a demo.

Where does my code go?

The code index and memory stay in the databases you run. Text still leaves the machine if you use cloud models: an embedding provider receives the pieces it turns into embeddings, and a language-model provider receives prompts that can include source, decisions and rules. Connected agents receive tool results under their own service’s policy.

For local-only operation, point both model roles and their endpoints at local models in Settings, disable external notifications, webhooks and remote integrations, and use a local agent connection. Details are in the FAQ.

Can I trust what Brain hands my agent?

Treat it as a starting point. A context pack selects files, rules and decisions for one task; it can miss evidence or lag behind the latest edits, so the agent should still read current source and run tests. Quality shows how well search finds the right code on a fixed test set, which isn’t a measure of coding results.

How do I update Brain?

Back up .env and your data first. On a local checkout, fetch tags and check out the new release tag, run ./scripts/bootstrap.sh, refresh web packages with cd apps/web && npm ci, and restart with ./scripts/start.sh. On a server, follow the runbook and the backup guide.

Glossary

The same explanations appear when you hover a dotted-underlined word.

Piece (chunk)
A small piece of a file — a function, a class or a few paragraphs. Brain stores code in pieces so it can find exactly the right one.
Searchable
Brain has turned this piece into a meaning fingerprint (an embedding), so it can be found by what it does, not just by its exact words.
Index
Brain reading your repository: files, functions and how they connect. Like a book's index, it must be redone when the book changes.
Context pack
A context pack selects files, rules and decisions for one task. It can miss relevant evidence; agents still need to inspect current source.
Reranker
A second, more careful pass over search results that re-orders them by how well they actually match the question.
MCP
Model Context Protocol — the standard plug that lets AI agents like Claude Code or Codex call Brain's tools.
Agent
An AI coding assistant (Claude Code, Codex, Cursor, Devin) that asks Brain for context before changing code.
Principal
Anyone or anything that can sign in to Brain — a person, an AI agent or a service — each with its own revocable key.
Scope
What a key is allowed to do, e.g. read code (core:read) or record decisions (memory:write).
Drift
The code structure moving away from the architecture you agreed on.
Coupling
Two parts of the code that keep changing together — a sign they are more tangled than they look.
Hotspot
A file that changes far more often than the rest. Bugs cluster here.
Golden set
A fixed set of curated questions or tasks with expected answers. Results describe that dataset, not general coding effectiveness.
p95
95% of calls finish faster than this. The slowest 5% are slower.
Freshness
How recently Brain re-read this repository. When Brain can't reach the source it can't tell whether its copy is current — answers come from the last version it read.
Degraded
The job finished but not completely — part of the work was skipped or fell back to a simpler path. Results are usable, just weaker.
Tokens
Units a model tokenizer assigns to text. Counts vary by model; smaller context alone does not establish lower total cost or faster coding.

Guides

The latest documentation on GitHub.

  • Getting started — Install, index a repository and run a first task
  • Connect agents (MCP) — Client configs and every tool an agent can call
  • Memory — Decisions, rules, lessons and how they are recalled
  • Dashboard — What each screen shows
  • FAQ — Privacy, costs, offline use and limits
  • Deployment — Running Brain on a remote server with TLS and keys