README.zh.md
README.zh.md
Tesserae
English · 한국어 · 日本語 · Русский · Español · Français · Deutsch
在线演示 · 文档 · MCP 配置 · Obsidian 导出
Tesserae 是一个项目记忆编译器。把一个包含 Markdown、源代码以及可选 PDF/Office 文档/图片的目录交给它,它会提取一个类型化的知识图谱,写出一份可查询的 wiki,并产出可移植的工件:Markdown 投影、面向 Cognee 的 bundle、智能体 harness,以及一个 MCP 服务器——你可以把它接到 Claude Code、Codex 或任何 MCP 客户端。它是为项目上下文准备的构建步骤,而不是托管服务。
何时使用(以及何时不要使用)
适合在以下情况使用:
- 你希望为单个项目中以文本为主的来源(文档、代码、研究笔记)建立一个持久、可检视的知识图谱。
- 你需要一个本地 MCP 服务器,依据自己的文件来回答问题。
- 你想给 Cognee 灌入一份干净的 bundle,或者把 Markdown 投影放进 Obsidian,而不必自己写胶水代码。
下列情况请跳过:
- 只需要在一个小目录上做向量检索 ——
ripgrep加一个 embedding 库就够了。 - 想要一个带编辑界面的托管 wiki。这里的静态站点是只读的。
- 期望开箱即用的高质量语义 embeddings。默认的 RAG-Anything embedding 是确定性的(见状态)。
- 期望一个一键式的"什么都问"智能体。这套工具构建的是底座,最终接入哪个智能体仍由你决定。
状态
这是一个不断演进的研究/智能体工具项目。已知限制:
- 编译时间大致与语料规模成线性关系。在大型 Markdown 树(数千个文件)上的首次编译可能需要几分钟。
- RAG-Anything 默认的 embedding provider 是
deterministic。它可复现且无外部依赖,但语义召回有限。要获得更好的检索质量,请切换到ollama(例如qwen3-embedding:0.6b)或 OpenAI 兼容端点 —— 见 docs/integrations/rag-anything.md。 - RAG-Anything 的视觉支持(图像内容抽取)尚未端到端打通。图像文件只做结构化解析,不会被描述。
- Cognee runtime cognify 是 best-effort:缺失的 provider、付费 API 密钥或网络故障只会被记录并跳过,不会中断构建。
- MCP 服务器暴露的工具集合是稳定的,但底层图谱 schema 仍可能继续扩充。
快速开始
需要 Python 3.9 以上。若启用 RAG-Anything,则需要 Python 3.10 以上。
pip install tesserae
cd /path/to/my-project
tesserae project setup
tesserae project compile
tesserae project ask "Where is Mermaid rendering implemented?"
tesserae project build-site && tesserae project serve --port 8765
setup 向导会检测常见来源(README.md、docs/、src/、data/),并写入 .tesserae/config.json。涉及 LLM 调用的功能默认使用基于 OAuth 的 codex CLI,因此常规路径无需 API key。更详细的内容见 docs/quickstart.md 和 docs/installation.md。