内容
<p align="center">
<a href="https://brein.sh"><img src="assets/brain.gif" alt="brein" width="320"></a>
</p>
<h1 align="center">brein</h1>
<p align="center"><em>一个常驻在您公司的智能大脑。</em></p>
brein 是一个本地的 MCP 服务器，用于存储公司记忆，存放在 git 中：存储库中的 markdown 文档，可由 AI 代理读取和写入。与 Claude Code、Cursor、Codex、Hermes 和任何 stdio MCP 客户端配合使用。
网站：https://brein.sh
## 快速入门
```bash
npx brein init
```
引导您完成大脑存储库、路径、评估和 MCP 客户端配置。然后重启您的客户端并使用 `brein doctor` 进行验证。
要求：Node、Python 3.11+、`git`，一个支持 MCP 的客户端。
<details><summary>从源码</summary>
```bash
git clone https://github.com/brein-sh/brein && cd brein
uv sync
brein setup
brein mcp claude
```
</details>
## 命令行界面
```bash
brein setup [section] # 所有章节，或以下之一：存储库 路径 矢量 评估 mcp
brein doctor # 运行健康检查，返回 ok/warn/fail
brein mcp <client> # claude | cursor | codex | generic
brein config # 显示已解析的配置
brain-eval --limit 20 # 针对 $BRAIN_REPO 的本地检索评估
```
## 通过 MCP 公开的工具
| 工具 | 用途 |
| --- | --- |
| `brain_search(query, mode="hybrid")` | 关键词 / 向量 / 混合检索，支持可选的重排序。 |
| `brain_evidence(question)` | 排名文档 + 片段 + 摘录 + 引用，一次性完成。客户端代理写入最终答案。 |
| `brain_update(file_path, content, commit_message, mode)` | 写入允许的路径，验证，提交，推送。 |
| `brain_audit()` | 存储库清洁度，文档/前言计数，日志 + 索引健康状况。 |
| `brain_retrieval_log(...)` | 遥测；搜索自动日志。 |
对于纯读取/列表，代理直接对大脑存储库使用其正常的 文件工具（`Read`、`Glob`、`Grep`）- MCP 仅协调纯工具无法完成的操作：语义搜索和策略控制的写入。
写入策略：`docs/`、`skills/`、`templates/` 下的路径，以及根目录下的 `AGENTS.md`、`README.md`、`CONTRIBUTING.md`。密钥按模式阻止。
## 配置
`brein setup` 写入 `~/.brein/config.json`。环境变量覆盖文件，详见 [`src/brain_mcp/config.py`](src/brain_mcp/config.py)。主要的：
- `BRAIN_REPO` — 您的脑部 git 存储库路径（必需）
- `BRAIN_RETRIEVAL_LOG` — JSONL 遥测路径
- `BRAIN_VECTOR_INDEX` — 矢量索引缓存路径
- `BRAIN_EMBEDDING_MODEL` — fastembed 模型（默认为 `BAAI/bge-small-en-v1.5`）
## 项目布局
```text
src/brain_mcp/ MCP 服务器 + `brein` 命令行界面
src/brain_mcp/_scripts/ 捆绑助手（评估、索引、验证）
```
## 贡献
问题和 PR 欢迎。参见 `CONTRIBUTING.md`。
## 许可证
MIT。参见 `LICENSE`。
