# Uptimizr

> Open-source, privacy-first analytics for 3D scenes: view-direction and click heatmaps, mesh interactions, navigation, performance, WebXR, session replay, and an AI-first agent layer (semantic metric registry, OpenAPI, MCP server).

Self-hosted: a single Fastify collector writes to an embedded DuckDB file by default,
with optional Postgres, SQL Server and ClickHouse stores. Connectors exist for
Babylon.js, three.js, PlayCanvas, react-three-fiber, A-Frame and Unity/Godot/Unreal
web exports.

Agents: the collector's read API is generated from a semantic metric registry
(`@uptimizr/metrics`), served as OpenAPI 3.1 at `/api/v1/openapi.json` and as MCP
tools by `@uptimizr/mcp`. Prefer `format=summary` on aggregate reads.

## Documentation Sets

- [Abridged documentation](https://www.uptimizr.com/docs/llms-small.txt): a compact version of the documentation for Uptimizr, with non-essential content removed
- [Complete documentation](https://www.uptimizr.com/docs/llms-full.txt): the full documentation for Uptimizr
- [SDK and connectors](https://www.uptimizr.com/docs/_llms-txt/sdk-and-connectors.txt): installing the SDK and every 3D engine connector
- [Capturing and using data](https://www.uptimizr.com/docs/_llms-txt/capturing-and-using-data.txt): configuration, mesh tracking, custom events, sessions, performance, replay, overlays and dashboard panels
- [AI and agents](https://www.uptimizr.com/docs/_llms-txt/ai-and-agents.txt): the agent layer: metric registry, MCP server and in-browser assistant
- [HTTP API](https://www.uptimizr.com/docs/_llms-txt/http-api.txt): ingestion, query, metadata and project-context endpoints, and auth
- [Deploy and self-host](https://www.uptimizr.com/docs/_llms-txt/deploy-and-self-host.txt): running the collector and dashboard, privacy and configuration

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [GitHub repository](https://github.com/RaananW/Uptimizr): Source, ADRs, and the integration reference.
- [Live demo](https://demo.uptimizr.com): Playground + dashboard running entirely in the browser.