# Rikoo

> Rikoo is the layer between an agent prototype and a service you can hand to customers, employees and auditors. Self-hosted, model-agnostic, governed from day one.

Every documentation page below also answers to `Accept: text/markdown`,
or to the same URL with a `.md` suffix. The whole documentation in one
file is at https://rikoo.io/llms-full.txt.

## Get started

- [Quickstart](https://rikoo.io/docs/quickstart.md): Install Rikoo, connect a model provider, build and publish an agent in the Studio, then expose it on your site or through the public API.
- [Core concepts](https://rikoo.io/docs/core-concepts.md): Five words carry the whole product. Everything else in this documentation is built on them.
- [Roles and permissions](https://rikoo.io/docs/roles-and-permissions.md): Roles are held at two levels, the organization and the project. On a project where someone holds a project role, that role replaces their organization role.
- [Environments](https://rikoo.io/docs/environments.md): Every agent has two environments, test and live. Each serves its own published version, so your team can try a version while your users keep the current one.

## Platform

- [Model providers](https://rikoo.io/docs/model-providers.md): The catalog lists 34 providers, including vLLM, Ollama and a custom entry for any OpenAI-compatible endpoint. The API key is sealed in the vault, and moving an agent to another provider changes its model, not its instructions or tools.
- [Knowledge collections](https://rikoo.io/docs/knowledge-collections.md): Sources are stored once in a project's library, then attached to collections. An agent searches the collections you grant it, and nothing else.
- [Agents and versions](https://rikoo.io/docs/agents-and-versions.md): Configure the agent, save a version, publish it. A version never changes once saved, and each run freezes its grants and skills when it starts.
- [Sub-agents and skills](https://rikoo.io/docs/sub-agents-and-skills.md): Delegation that cannot widen access, and reusable bundles of instructions and capabilities.
- [Tools and MCP servers](https://rikoo.io/docs/tools-and-mcp-servers.md): Connect Rikoo to your systems through the Model Context Protocol, authenticated by a vault secret or by OAuth 2.1, and narrowed tool by tool.
- [Guardrails](https://rikoo.io/docs/guardrails.md): Checks applied to the incoming message before the model and to the answer before your user, saved with the agent version and recorded in the trace.
- [Secret vault](https://rikoo.io/docs/secret-vault.md): Credentials are sealed when they are written and no endpoint ever returns them. Only the worker opens them, at the moment of an outgoing call.
- [Budgets and quotas](https://rikoo.io/docs/budgets-and-quotas.md): A cost ceiling and a token ceiling on every run, set on the agent version. What a call cost is computed from the tokens the provider reports and the model's price, never guessed.

## Self-hosting

- [Self-host Rikoo](https://rikoo.io/docs/self-hosting.md): What runs when you host Rikoo yourself, which edition to choose, and how to deploy it.
- [Docker Compose](https://rikoo.io/docs/self-hosting/deployment/docker-compose.md): Run the whole Rikoo platform on one machine with Docker Compose.
- [Kubernetes (Helm)](https://rikoo.io/docs/self-hosting/deployment/kubernetes-helm.md): Deploy Rikoo on a Kubernetes cluster with the rikoo Helm chart.
- [Infrastructure](https://rikoo.io/docs/self-hosting/deployment/infrastructure.md): The services Rikoo runs, the stores it depends on, and what each must provide.
- [Enterprise license](https://rikoo.io/docs/self-hosting/license-key.md): What the Enterprise license unlocks, and how to activate it on a self-hosted instance.

## Reference

- [Widget and JavaScript SDK](https://rikoo.io/docs/widget-and-sdk.md): One script tag on your site. The look is set in the Studio and applies live; what the agent may do is pinned to a version.
- [Slack app](https://rikoo.io/docs/slack-app.md): Your agent in a Slack workspace, answering in the thread. Every event is verified before it becomes a run.
- [Public API](https://rikoo.io/docs/public-api.md): A versioned REST API for your own code: conversations with an agent, attachments, feedback, knowledge search and text pipelines, authenticated by project API keys.
- [Alerts](https://rikoo.io/docs/alerts.md): The platform watches itself with 48 rules, and announces what they find in the Studio, by e-mail or to a webhook.
- [Observability](https://rikoo.io/docs/observability.md): Traces to your own collector, metrics for your own Prometheus, a ready-made Grafana dashboard, and an audit log kept apart from the diagnostic logs.
- [Enterprise modules](https://rikoo.io/docs/enterprise-modules.md): What the Enterprise license adds, module by module. Each module is separable, and the platform runs without any of them.

## Optional

- [Model Context Protocol server](https://rikoo.io/api/mcp)