# Zindex

> Agent-native diagram state infrastructure. Zindex is a stateful diagram runtime for AI agents - create architecture diagrams, ERDs, workflows, sequence diagrams, org charts, and topology maps from structured data, then patch, validate, diff, and render them as systems change. Not a whiteboard. Not a Mermaid clone. A database-like backend for diagrams with stable IDs, typed operations, semantic validation, immutable revisions, auto-layout, and SVG/PNG rendering. Try the engine without signup at `api.zindex.ai/v1/scenes/{validate,render,normalize}` (no API key, rate-limited 30/min per IP); persisted scenes require a key.

The canonical agent entry point is [https://zindex.ai/](https://zindex.ai/) - fetch it with `Accept: text/markdown` for imperative onboarding instructions. Agents using Model Context Protocol should install the MCP server `@zindex-ai/mcp` and configure it with a `ZINDEX_API_KEY` environment variable (free key at [https://zindex.ai/signup](https://zindex.ai/signup)). See [the MCP setup guide](https://zindex.ai/docs/getting-started/mcp-setup/) for the full host config snippet.

## Agent onboarding

- [Canonical agent front door](https://zindex.ai/): start here with `Accept: text/markdown`
- [MCP setup](https://zindex.ai/docs/getting-started/mcp-setup/): install and configure the MCP server

## Examples (executable patterns)

- [Examples index](https://zindex.ai/examples/): browse the gallery of executable use cases
- [Examples manifest](https://zindex.ai/examples/index.json): machine-readable manifest with per-example resource URLs
- Each example exposes structured resources at `/examples/<slug>.scene.json` (canonical DSP scene), `/examples/<slug>.ops.json` (typed-operation envelope), `/examples/<slug>.workflow.json` (agent workflow recipe), `/examples/<slug>.diff.json` (sample dsp_diff_scene response), `/examples/<slug>.github-actions.yml` (runnable CI workflow), `/examples/<slug>.svg` (rendered diagram), `/examples/<slug>.md` (markdown summary). Three showcase examples additionally expose `/examples/<slug>.before.svg` for the side-by-side revision-diff display.

## Protocol

- [Protocol overview](https://zindex.ai/docs/protocol/overview/): DSP high-level shape
- [Scene schema](https://zindex.ai/schemas/scene.schema.json): JSON Schema for DSP scene documents
- [Ops schema](https://zindex.ai/schemas/ops.schema.json): JSON Schema for DSP operations
- [Operations reference](https://zindex.ai/docs/protocol/operations/): the typed operation set (createNode, createEdge, applyOps, etc.)

## Reference

- [Element types](https://zindex.ai/docs/reference/element-types/): node/edge types by diagram family
- [Diagram classes](https://zindex.ai/docs/reference/diagram-classes/): architecture, workflow, sequence, ER, orgchart, uiflow, network
- [Constraints](https://zindex.ai/docs/reference/constraints/): align, order, sameSize, distribute, stack, centerIn, contain, grid, minGap, noOverlap
- [Rendering](https://zindex.ai/docs/reference/rendering/): themes, style cascade, contrast, render diagnostics (TEXT_OVERFLOW, CANVAS_AUTO_EXTENDED, CANVAS_AUTO_TIGHTENED, CANVAS_CONTENT_OFFSET, EDGE_LABEL_SUPPRESSED_REDUNDANT, EDGE_LABEL_SUPPRESSED_FANIN, EDGE_LABEL_FANIN_BUNDLED, EDGE_OBSTACLE_GRAZED, EDGE_COLUMN_NOT_FOUND, LABEL_DUPLICATION_DETECTED, LAYOUT_ABSOLUTE_AT_ORIGIN, LAYOUT_STRATEGY_OVERRIDDEN, MISSING_DIAGRAM_FAMILY, NODE_OVERLAP_DETECTED, OUTER_FIELD_NESTED, MISSING_GLYPH, AUTOGROUP_FAMILY_MISMATCH, AUTOGROUP_SUPPRESSED_TRIVIAL, AUTOGROUP_SKIPPED_ABSOLUTE)
- [Layout engine](https://zindex.ai/docs/reference/layout-engine/): auto-layout scope, canvas-aware spread, and refinement
- [Validation rules](https://zindex.ai/docs/reference/validation-rules/): the full diagnostic-code catalog with severity, payload shape, and recovery action per code
- [Revisions](https://zindex.ai/docs/reference/revisions/): immutable revision model and diff

## API

- [API endpoints](https://zindex.ai/docs/api/endpoints/): REST reference
- [OpenAPI spec](https://api.zindex.ai/openapi.json): machine-readable API contract
- [API root](https://api.zindex.ai/): service description with Link headers

## Privacy

- [Privacy commitments](https://zindex.ai/privacy): scene content encrypted at rest, no LLM subprocessors, anonymize before sharing with support, atomic deletion

## Source

- [GitHub](https://github.com/zindex-ai): open-source monorepo