尚无译文的页面会以英语打开,并标注为英语。
本页由机器从英文原文翻译,内容以英文原文为准。 Machine-translated from the English page, which is authoritative.
ClickHouse Loom 文档
Loom 是面向 AI agent 的记忆、文档和代码索引服务器,数据存储在 ClickHouse 中,也可以选择用 Postgres 存放实时记忆和知识状态。agent 和用户可以通过 MCP、HTTP、Python 和 TypeScript SDK 以及控制台访问它。本页按阅读顺序列出了所有页面。

从这里开始
| 步骤 | 阅读 |
|---|---|
| 1. 评估 | 概览 → 评估 Loom |
| 2. 安装 | 快速开始 → 部署 |
| 3. 连接 agent | 连接编码 agent → 集成 |
| 4. SDK 和 API | 你的第一个 agent → Python SDK / HTTP API |
| 5. 命名空间与访问 | 身份与命名空间 → 令牌与授权 |
| 6. 代码索引 | 代码索引 → 代码仓库 → 代码索引运维 |
| 7. 运维 | 监控 · 故障排查 · 升级 · 备份与恢复 |
使用场景
每个需求一个页面,说明 Loom 能为此做什么,以及从哪里开始: agent 记忆 · 文档搜索与 RAG · 面向编码 agent 的代码索引 · 按语言划分的代码索引 · 与代码关联的记忆 · 编码 agent 的模型成本 · 多 agent 共享上下文 · 自主 agent:召回、审计、擦除 · 运行、追踪与 PR 历史 · 基于 ClickHouse 的自托管 · 所有使用场景。
1. 快速入门
- 概览:Loom 是什么、适用场景、前提条件。
- 包含的功能:Loom 的主要能力,每项都附有对应页面。
- 快速开始:完整走通本地部署。
- 配置模型和 API 密钥:agent 订阅、服务器 LLM、嵌入模型以及单一提供商的配置。
- 评估 Loom:冒烟测试、工作负载评估以及可复现的公开基准测试。
- 连接编码 agent:插件或 MCP 接入。
- 通过编码 agent 设置 Loom:适用于由 agent 安装固定版本并验证其可用的场景,附有固定格式的报告。
- 你的第一个 agent:SDK 教程。
2. 安装并运行服务器
- 部署:部署形态、环境、提供方、身份模式、代理、镜像、生产环境检查清单。
- 单点登录:为控制台、
loom login和 MCP 客户端接入 OIDC 身份提供方。 - 不使用控制台使用 Loom:
loom login、loom call和 SDK 可完成控制台每个视图的调用。 - 升级 · 受支持的版本 · 备份与恢复 · 监控 · 维护 · 运行时设置 · 故障排查 · 代码索引运维 · 运行 N 个副本:多个相同的 Loom 位于同一个 URL 之后 · Postgres:Postgres 记忆权威存储 · Kubernetes:Helm chart,附带 EKS 和 kind 覆盖配置 · ClickHouse Cloud 与 Managed Postgres:基于这两项托管服务的 chart · 将命名空间复制到另一个 Loom · 将用量导出到数据仓库
3. 连接 agent
集成 · MCP 客户端 · Agent 指令 · Claude Code · Codex · Cursor · VS Code · 框架 · Grep 垫片 · Langfuse · ClickStack · OKF
4. SDK 与 API
参考索引 · HTTP API · MCP · Python SDK · TypeScript SDK · 环境变量 · 运维 · 配置 · 工作进程 · CLI · 错误 · 状态 · 数据模式 · 提取器契约。各个版本之间,操作和字段会有变化;未知字段和已移除字段说明了客户端如何处理服务器不再读取的字段。
5. 命名空间、访问与记忆模型
指南
agent 集成 · 无头机器人 · 令牌与授权 · 跟踪并恢复长时间运行 · 优化命名空间 · 调查类 agent 的记忆 · 提取流水线 · 性能调优 · 调试 · 从 Postgres 查询 Loom · 使用 Loom 教学
功能
- 平面:命名空间与共享 · 统一搜索 · 知识 · 实体图 · 对话与会话 · 运行 · 任务与决策 · 控制台
- 记忆:写入 · 搜索与提问 · 冲突与拒绝 · 提取 · 历史与来源 · 保留与删除 · 流程与经验 · 工作记忆与档案
- 可观测性:审计 · 成本与用量 · 遥测
- 跟踪器:概览 · 记录约定
6. 代码索引
概览 · 仓库 · 新鲜度 · 历史与 PR · 运维 · 代码索引运维手册
架构
系统概览 · 服务器布局 · ClickHouse · 记忆架构 · 存储权威 · 单元 · 存储布局 · 代码索引架构 · 文档提取 · 文档来源 · LLM 与嵌入 · 安全 · 助手设计 · 故障与恢复 · 滚动升级
基准测试
概览 · 覆盖范围 · 方法论 · 运行 · 结果 · 添加用例 · Skill 评测
开发
面向贡献者:仓库指南 · 本地开发 · 测试 · 代码生成 · 迁移 · 发布流程 · 文档风格 · 整理循环设计 · 扩展 Loom · 添加操作 · 添加 worker · 添加表 · 添加语言支持 · 控制台设计。 CONTRIBUTING.md 介绍了 pull request 的工作流程。
另请参阅
术语表:Loom 的术语,每个只定义一次。常见问题:最先会遇到的问题,每个问题一段回答。llms.txt:为 agent 生成的文档索引;llms-full.txt 将说明 Loom 是什么以及如何开始使用的页面合并在一个文件中。