Documentation

Welcome to the Admina documentation. Admina is an open source governance framework (Apache 2.0) for AI agents and LLM systems. It provides governed AI development through an SDK, a transparent MCP proxy, an OpenAI-compatible gateway, plugin system, CLI, and real-time dashboard.

⚡
Quick Start
Governance in 5 minutes. Zero-Docker by default — pip install, admina init, admina dev, then point any OpenAI client at it.
→
🏛️
4 Governance Domains
Data Sovereignty, AI Infrastructure, Agent Security, Compliance.
→
📊
Admina Score
Live-runtime governance composite (0–100). Formula, components, how to improve.
→
🛡️
OISG Adequacy
Open · Intelligent · Secure · Governed — Admina's default paradigm.
→
🔌
Integrations
Framework connectors, seven model adapters, and the OpenAI-compatible gateway.
→
📡
API Reference
JSON-RPC 2.0 proxy API, REST endpoints, and the /v1 gateway with SSE streaming.
→
🌐
Gateway & Streaming
Point any OpenAI-compatible client at Admina. Governed SSE with windowed PII redaction.
→
⚙️
Rust Engine
Build admina_core, benchmarks, Python/Rust hybrid mode.
→
🔧
Configuration
Environment variables, domain tuning, deployment modes.
→

What is Admina?

Admina is an open framework for governed AI development. It works as an SDK (in-process GovernedModel, GovernedData, GovernedAgent, ComplianceKit), a transparent MCP proxy (POST /mcp) and — since v0.11.0 — an OpenAI-compatible HTTP gateway (POST /v1/chat/completions, GET /v1/models) that any OpenAI-compatible client can be pointed at. Every AI interaction is automatically governed: PII redacted, injections blocked, loops broken, actions audited, and EU AI Act compliance tracked.

Streamed responses are governed too: PII spanning delta boundaries is redacted through a windowed recomposition buffer, both in the SDK's GovernedModel.stream() and on the gateway's SSE path.

Key properties:

  • OISG adequate on the full stack — Open · Intelligent · Secure · Governed, scored automatically from live runtime state (Docker Compose 85; bare pip install 75, Good coverage)
  • Bidirectional — both requests and responses are governed
  • Three governed surfaces — SDK (in-process), MCP proxy, and an OpenAI-compatible gateway
  • Hybrid runtime — Rust core (~6µs median) with automatic Python fallback
  • Plugin system — 9 interfaces, 17 built-in implementations
  • 6 framework integrations — OpenClaw, LangChain, CrewAI, n8n, Cheshire Cat AI, GuardrailsAI
  • EU AI Act compliant — risk classification and gap analysis built in
  • Apache 2.0 — free to use, modify, and distribute forever

Architecture at a glance

Admina has two runtime shapes, both covering the same 4 governance domains. The default is zero-Docker: a single uvicorn process that serves the governance proxy, the REST API and the bundled dashboard on one port, :3000. admina dev --stack splits the same surface across Docker Compose containers, which is where the additional ports appear. 

# Default — local mode, no Docker
admina dev

#  proxy + REST API + dashboard → :3000  (single process)

# Full stack — proxy, dashboard, ClickHouse, Redis, OTEL collector, Grafana
admina dev --stack

#  proxy      → :8080  (governance proxy + REST API)
#  dashboard  → :3000  (real-time governance UI)
#  otel       → :4317  (OpenTelemetry collector gRPC)
#  grafana    → :3001  (metrics and traces)

:8080, :3001 and :4317 exist only under --stack. In local mode everything is on :3000 (auto-fallback to the next free port if it is taken). See Quick Start.