UModel 中文文档入口。中文文档与英文文档分别维护在 docs/zh 和 docs/en 下，目录结构保持一致，示例、命令和公共契约引用保持对齐。
文档总入口：docs/README.md
English: UModel Documentation
入门
- 项目 README - 项目定位、快速开始、架构和治理入口。
- 安装与本地环境 - 依赖、构建、启动和 GraphStore provider 选择。
- 快速开始 - 创建 workspace、导入多域样例、运行第一组查询。
- GraphStore Providers -
memory、file.memory、local.ladybug的选择和边界。 - 部署 - Docker、Compose、端口、数据目录和 provider 配置。
概念
- 概念索引 - 推荐阅读顺序和概念地图。
- 对象图语义层 - UModel 解决的问题，以及它与企业数据、遥测、运行时系统和 Agent 上下文的关系。
- Workspace 与 Domain - 隔离、命名和本地持久化边界。
- Model Elements - 模型元素的通用 envelope 和支持的 kind。
- EntitySet - 对象类型定义与运行时实体的关系。
- DataSet - 指标、日志、链路、事件、Profile 和 Runbook。
- Link 与字段映射 - DataLink、EntitySetLink、StorageLink 和
fields_mapping。 - Storage 与 GraphStore - 模型中的存储定义与运行时 provider。
- Entity 与 Relation - 运行时对象图数据和生命周期。
- 查询入口 -
.umodel、.entity、.topo、explain 和 Agent 用法。
使用指南
- 模型编写指南
- 实体与关系写入指南
- Query Service 指南
- Web UI 指南
- SDK 与客户端指南 - REST、CLI、MCP、生成模型 SDK 和集成示例。
- MCP 示例 - stdio、Streamable HTTP、HTTP+SSE 和 TOON payload 示例。
架构
- 架构总览 - 系统视图、分层、公共契约和 guardrails。
- 运行时流程 - 启动、导入、写入、查询、Agent 和持久化流程。
- Query 与 Agent 架构 - Query Service 与 AgentGateway 边界。
- 扩展点 - 模型包、Schema、Provider、Query、API、SDK 和 UI 扩展。
- Web UI 架构
参考
- CLI 参考
- MCP 参考
- Web UI API 对照
- UModel SDK 规范
- REST OpenAPI
- MCP Tool 和 Resource Schema
- 公共 Go Contracts
- 公共领域模型
- 稳定错误码
生成的 Schema 文档
从仓库根目录重新生成：
make doc