内容
# 知识引擎
[](LICENSE)
[](https://www.python.org)
[](02-dev-docs/CHANGELOG.md)
[](https://modelcontextprotocol.io)
> 自托管的知识引擎，适用于您的 Markdown 笔记。从 Claude Desktop、Cursor 或任何 MCP 客户端搜索它们。在本地运行仪表板，指向您自己的语料库。
知识引擎索引一个 Markdown 文件夹，通过 HTTP API 和本地仪表板提供全文（和可选的语义）搜索，并通过 MCP stdio 服务器将相同的搜索功能暴露给 AI 助手。您提供语料库；引擎使其可搜索 — 在浏览器中，从 CLI，以及从任何支持 MCP 的助手。所有内容都在本地运行，并获得 MIT 许可。
## 快速入门
> **先决条件（Debian / Ubuntu）：** 首先安装 `python3-venv` — `sudo apt install python3-venv`。`python3 -m venv` 需要；macOS 和 Windows 上已捆绑。
```pwsh
# Windows
.\scripts\install.ps1
.\engine\.venv\Scripts\Activate.ps1
knowledge-engine bootstrap
knowledge-engine capabilities
knowledge-engine reindex
.\scripts\serve.ps1
# 打开 http://127.0.0.1:9210/ui/
```
```bash
# macOS / Linux
./scripts/install.sh
source engine/.venv/bin/activate
knowledge-engine bootstrap
knowledge-engine capabilities
knowledge-engine reindex
./scripts/serve.sh
# 打开 http://127.0.0.1:9210/ui/
```
在 `serve` 之后，仪表板位于 <http://127.0.0.1:9210/ui/>，OpenAPI 文档位于 <http://127.0.0.1:9210/docs/>。
存储库附带一个小型演示语料库 — **1 个演示库**（`corpus/samples/demo-library`）和 **1 个演示技能**（`corpus/samples/demo-skill`），两者均默认启用 — 因此 `reindex` 在全新克隆时执行真实工作。在准备好时，将它们替换为自己的内容（参见 [添加您自己的语料库](01-user-docs/BRING-YOUR-OWN-CORPUS.md)）。
如果 `corpus/registry.json` 引用的库不在 `corpus/` 中，索引器会跳过它，并且 `knowledge-engine bootstrap` 会打印一个警告，说明缺少的库。
**要添加您自己的语料库：** 将文件夹放入 `corpus/libraries/`（默认为 gitignore）或 registry 指向的任何位置。作者指南位于 [BRING-YOUR-OWN-CORPUS.md](01-user-docs/BRING-YOUR-OWN-CORPUS.md) 和 [LIBRARY-AUTHORING.md](01-user-docs/LIBRARY-AUTHORING.md)。
## 功能
- FastAPI 应用，带有健康检查、信息、搜索、注册、生成和面板路由；在 `/ui/` 处使用单个文件 Alpine.js + Tailwind 仪表板
- MCP stdio 服务器（JSON-RPC 2.0，协议 `2024-11-05`）— 与 Claude Desktop、Cursor、Continue、任何 MCP 客户端兼容
- SQLite FTS5 索引器，带有 `bm25` 排名 + 摘要高亮；可选的 bge-m3 嵌入索引，用于语义搜索
- 可拔插的提供者抽象（echo / Ollama / cloud HTTP 存根）用于生成路由
- 项目上下文、代理面板、托管工具和沙盒基板，您可以填充自己的项目和代理
- `corpus/samples/` 下的演示语料库，注册定义位于 `corpus/registry.json` + `corpus/registry.schema.json`
## MCP 服务器
```pwsh
knowledge-engine mcp # JSON-RPC 2.0 over stdio, protocol 2024-11-05
```
基本工具是 `search`、`registry_list`、`registry_toggle` 和 `registry_get`。可选工具组在运行时可以导入它们，并在配置中启用时添加项目上下文和面板工具。运行 `knowledge-engine capabilities` 查看当前的检索和功能表面，包括空但可用的基板。参见 [scripts/mcp-client-config.example.json](scripts/mcp-client-config.example.json) 获取可直接编辑的配置，以及 [MCP-WIRING.md](01-user-docs/MCP-WIRING.md) 客户端设置。
## 文档
- **用户指南** — [`01-user-docs/`](01-user-docs/README.md)：安装（快速入门）、添加您自己的语料库、库和技能创作、MCP 连接、嵌入、部署、主题、FAQ。
- **引擎内部** — [ARCHITECTURE.md](02-dev-docs/ARCHITECTURE.md)、[CATALOG.md](02-dev-docs/CATALOG.md) 和 [CHANGELOG.md](02-dev-docs/CHANGELOG.md)。
## 本项目不提供的内容
- 预建的知识库 — 您提供库。
- 身份验证/多用户分离开箱即用 — 默认应用程序是本地信任；请在公开之前加强保护（参见 [DEPLOYMENT.md](01-user-docs/DEPLOYMENT.md)）。
- 预配置的多工作器代理运行时 — 引擎提供知识、面板、工具托管和沙盒适配器基板，但您需要提供项目特定的代理、工具、技能和执行适配器。
## 许可证
MIT — 参见 [`LICENSE`](LICENSE)。无限制地复刻、修改和重新分发（包括商业用途）。
Semver 应用于引擎包、MCP 协议和注册表模式。
