# Observal Docs

## observal docs

- [Installation](https://docs.observal.io/getting-started/readme.md)
- [Quickstart](https://docs.observal.io/getting-started/quickstart.md)
- [Overview](https://docs.observal.io/core-concepts/core-concepts.md)
- [Session tracking and reconciliation](https://docs.observal.io/core-concepts/session-tracking.md)
- [Overview](https://docs.observal.io/use-cases/use-cases.md)
- [Observe MCP traffic](https://docs.observal.io/use-cases/observe-mcp-traffic.md)
- [Share agent configs across harnesses](https://docs.observal.io/use-cases/share-agent-configs.md)
- [Debug agent failures](https://docs.observal.io/use-cases/debug-agent-failures.md)
- [Run a team-wide agent registry](https://docs.observal.io/use-cases/team-registry.md)
- [Teamspaces](https://docs.observal.io/use-cases/teamspaces.md)
- [Overview](https://docs.observal.io/cli-reference/cli.md)
- [observal api](https://docs.observal.io/cli-reference/api.md)
- [Mutation retries and idempotency](https://docs.observal.io/cli-reference/idempotency.md)
- [observal auth](https://docs.observal.io/cli-reference/auth.md)
- [observal config](https://docs.observal.io/cli-reference/config.md)
- [observal scan](https://docs.observal.io/cli-reference/scan.md)
- [observal outdated](https://docs.observal.io/cli-reference/outdated.md)
- [observal reconcile](https://docs.observal.io/cli-reference/reconcile.md)
- [observal inbox](https://docs.observal.io/cli-reference/inbox.md)
- [observal agent pull](https://docs.observal.io/cli-reference/pull.md)
- [observal registry](https://docs.observal.io/cli-reference/registry.md)
- [observal registry recommend](https://docs.observal.io/cli-reference/recommend.md)
- [observal registry version](https://docs.observal.io/cli-reference/component.md)
- [observal registry models](https://docs.observal.io/cli-reference/models.md)
- [observal agent](https://docs.observal.io/cli-reference/agent.md)
- [observal team](https://docs.observal.io/cli-reference/team.md)
- [observal ops](https://docs.observal.io/cli-reference/ops.md)
- [observal admin](https://docs.observal.io/cli-reference/admin.md)
- [observal doctor](https://docs.observal.io/cli-reference/doctor.md)
- [Support bundles](https://docs.observal.io/cli-reference/doctor/support.md)
- [observal self](https://docs.observal.io/cli-reference/self.md)
- [observal registry prompt](https://docs.observal.io/cli-reference/prompt.md)
- [observal server](https://docs.observal.io/cli-reference/server.md)
- [observal server migrate](https://docs.observal.io/cli-reference/server/migrate.md)
- [observal registry skill](https://docs.observal.io/cli-reference/skill.md)
- [Overview](https://docs.observal.io/self-hosting/self-hosting.md)
- [Requirements](https://docs.observal.io/self-hosting/requirements.md)
- [Single-node deployment](https://docs.observal.io/self-hosting/single-node-deploy.md)
- [Production deployment](https://docs.observal.io/self-hosting/production-deploy.md)
- [Docker Compose setup](https://docs.observal.io/self-hosting/docker-compose.md)
- [AWS deployment with Terraform](https://docs.observal.io/self-hosting/aws-terraform.md)
- [GCP deployment with Terraform](https://docs.observal.io/self-hosting/gcp-terraform.md)
- [Configuration](https://docs.observal.io/self-hosting/configuration.md)
- [Usage reporting](https://docs.observal.io/self-hosting/usage-reporting.md)
- [Ports and volumes](https://docs.observal.io/self-hosting/ports-and-volumes.md)
- [Databases](https://docs.observal.io/self-hosting/databases.md)
- [Authentication and SSO](https://docs.observal.io/self-hosting/authentication.md)
- [Upgrades](https://docs.observal.io/self-hosting/upgrades.md)
- [Backup and restore](https://docs.observal.io/self-hosting/backup-and-restore.md)
- [Troubleshooting](https://docs.observal.io/self-hosting/troubleshooting.md)
- [Copilot](https://docs.observal.io/integrations/copilot.md)
- [Cursor](https://docs.observal.io/integrations/cursor.md)
- [Goose](https://docs.observal.io/integrations/goose.md)
- [Kiro](https://docs.observal.io/integrations/kiro.md)
- [OpenCode](https://docs.observal.io/integrations/opencode.md)
- [Pi](https://docs.observal.io/integrations/pi.md)
- [Environment variables](https://docs.observal.io/reference/environment-variables.md)
- [API endpoints](https://docs.observal.io/reference/api-endpoints.md)
- [Hooks specification](https://docs.observal.io/reference/hooks-spec.md)
- [Config files](https://docs.observal.io/reference/config-files.md)
- [Security assurance case](https://docs.observal.io/security/assurance-case.md)
- [Release verification](https://docs.observal.io/security/release-verification.md)
- [Contributing Guide](https://docs.observal.io/contributing/contributing.md)
- [Code Review Standard](https://docs.observal.io/contributing/code-review.md)
- [Development Guide](https://docs.observal.io/contributing/development_guide.md)
- [Testing Guide](https://docs.observal.io/contributing/testing_guide.md)
- [Fuzzing Guide](https://docs.observal.io/contributing/fuzz.md)
- [AI Policy](https://docs.observal.io/contributing/ai_policy.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.observal.io/getting-started/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.