内容
# data-olympus
data-olympus 是一款适用于智能代理工作队伍的治理级知识库格式和服务器。它是一种与 OKF(开放知识格式)兼容的配置文件(一种对 [开放知识格式](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf) 的兼容性扩展),具有治理扩展(稳定的 `id`,受控的 `type`/`status`/`tier` 字段,`supersedes` 链),以及一个单写入 MCP 服务器和命令行界面。结果是一个原生的 Git 版本控制的工程标准、架构决策和项目知识文档图,智能代理和人类可以阅读、搜索和扩展,而无需任何专有服务。
**状态:预发布(v0.1)。**
## 为什么
- **便携,无锁定。** 整个知识库是一个 Git 目录下的 Markdown 文件集合。无需数据库,无需专有模式,无需供应商。
- **原生的 Git 差异和评审。** 每次更改都是一次提交。拟议的编辑在提交前会经过一个待审队列;历史记录是纯粹的 Git 日志。
- **智能代理和人类可读。** 纯粹的 Markdown 带有 YAML 前置信息。无需 SDK 即可读取或编写文档。
- **受控的多智能代理写入。** 单写入 MCP 管道( advisory locks,每个会话的工作树,可持久的推送队列)可以防止并发写入竞争,无需分布式锁定基础设施。
- **按状态、层级和类型查询。** 按 `status: accepted`、`tier: T1` 或 `type: decision` 过滤,无需后处理。`supersedes` 链可以跟踪决策历史记录在整个图谱中。
- **与 OKF 兼容。** 任何 OKF 消费者都可以读取 data-olympus 包。任何 OKF 生成的包都可以通过 data-olympus 工具进行治理。
## 快速入门
```bash
# 安装
uv venv && uv pip install -e '.[dev]'
# 检查示例包
uv run data-olympus lint example-bundle
# 启动针对示例包的 MCP 服务器
./scripts/run-local.sh
```
参见 `docs/quickstart.md` 以获取完整的本地运行演练,包括 curl 和 `kb` 命令行界面查询。
## 文档
- [`SPEC.md`](SPEC.md):格式规范(包布局、前置信息模式、服务契约)。
- [`docs/quickstart.md`](docs/quickstart.md):验证的本地运行程序。
- [`docs/adoption.md`](docs/adoption.md):自带知识库指南(作者、检查、索引、服务、连接智能代理)。
- [`docs/serving.md`](docs/serving.md):单副本服务模型、只读副本、Git 拉取循环。
- [`docs/comparison.md`](docs/comparison.md):data-olympus 与 OKF、企业目录、Markdown 知识库工具、智能代理上下文约定、RAG 和 ADR 工具的关系。
## 许可证
Apache 2.0。参见 [`LICENSE`](LICENSE) 和 [`NOTICE`](NOTICE)。