UModel Documentation

中文：UModel 中文文档

UModel English documentation entry. English and Chinese documentation are maintained as separate documents under docs/en and docs/zh, with matching structure and aligned examples, commands, and public contract references.

Documentation root: docs/README.md

Getting Started

Repository README - project overview, Quick Start, architecture, and governance links.
Installation - prerequisites, local setup, build commands, and GraphStore provider selection.
Quick Start - create a workspace, import the multi-domain sample, and run the first queries.
GraphStore Providers - choose between memory, file.memory, and local.ladybug.
Deployments - Docker, Compose, ports, data directories, and provider configuration.

Concepts

Concepts Index - recommended reading order and concept map.
Object Graph Semantic Layer - why UModel exists and how it relates to enterprise data, telemetry, runtime systems, and agent context.
Workspaces And Domains - isolation, naming, and local persistence boundaries.
Model Elements - common model envelope and supported model kinds.
Entity Sets - object type definitions and runtime entity relationship.
Datasets - metrics, logs, traces, events, profiles, and runbooks.
Links And Field Mappings - DataLink, EntitySetLink, StorageLink, and fields_mapping.
Storage And GraphStore Providers - modeled storage versus runtime providers.
Entities And Relations - runtime graph records and lifecycle.
Query Surfaces - .umodel, .entity, .topo, explain, and agent usage.

Guides

Model Authoring Guide
Entity And Relation Write Guide
Query Service Guide
Web UI Guide
SDK And Client Guide - REST, CLI, MCP, generated model SDKs, and integration examples.
Agent Integration Guide - connect an MCP client, the agent tool/resource surface, the query surface an agent uses, and a worked incident-investigation walkthrough.
Agent Skills - loadable SKILL.md files for MCP/CLI agents: read entity/relation/model data and run model-guided root-cause analysis.
MCP Examples - stdio, Streamable HTTP, HTTP+SSE, and TOON payload examples.

Examples

Multi-Domain Quickstart Example Pack - five domains connected in one workspace; the default make quickstart sample.
Incident Investigation Demo - scenario-driven, AI-agent-assisted root-cause analysis of a payment-gateway SLO breach across business, platform, and runtime domains, with a runbook-guided diagnosis path.
Service Localization Demo - AI-agent-assisted bottleneck localization down a four-layer request stack (product → service → data → infra), centered on fetching telemetry at each hop.

Architecture

Architecture Overview - system view, layers, public contracts, and guardrails.
Runtime Flow - startup, import, write, query, agent, and persistence flows.
Query And Agent Architecture - Query Service and AgentGateway boundaries.
Extension Points - model packs, schemas, providers, query, API, SDK, and UI extensions.
Web UI Architecture

Reference

Specifications

Cross-implementation contracts that bind both unified-model (open source) and umodel-assistant (commercial). Breaking either is a P0 regression.

Plan Schema v1 - mode protocol, plan JSON envelope, and aligned method signatures for get_metrics / get_logs.

Generated Schema HTML

Regenerate schema HTML from the repository root:

bash

make doc

UModel Documentation ​

Getting Started ​

Concepts ​

Guides ​

Examples ​

Architecture ​

Reference ​

Specifications ​

Generated Schema HTML ​

Contributing And Release ​