# Documentation

ows-coda is a standalone AI agent for the Abacus royalties platform. It answers questions about accounts, contracts, advances, revenue, and ledger balances by calling live backend services via Claude's native tool use on AWS Bedrock. The system consists of an Express API server, a React/Vite client, a hybrid search microservice, and several shared library packages.

## Quick paths by role

| I am...                                  | Start here                                                                                              |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| **New to the team**                      | [Getting Started](getting-started.md) then [Architecture](architecture/overview.md)                     |
| **On-call and something is broken**      | [Runbook](operations/runbook.md), [Platform runbooks](operations/runbooks/)                             |
| **From another team, integrating**       | [API Reference](api/server.md), [MCP Server](guides/mcp-server.md), [Tool Catalog](api/tool-catalog.md) |
| **Evaluating compliance posture**        | [Security model](compliance/security.md), [Compliance matrix](compliance/compliance-matrix.md)          |
| **Investigating an agent quality issue** | [Observability](guides/observability.md), [Evals & quality](guides/evals.md)                            |

---

## I want to...

### Get started

- [Set up my dev environment](getting-started.md)
- [Understand the codebase](architecture/overview.md)
- [Domain glossary](glossary.md)

### Build something

- [Add a tool](guides/adding-a-tool.md)
- [Add a package](guides/adding-a-package.md)
- [Add an app](guides/adding-an-app.md)
- [Add a search index](guides/adding-a-search-index.md)
- [Integrate with the platform service](guides/platform-integration.md)
- [Run proto codegen](guides/proto-codegen.md)
- [Run tests](guides/testing.md)
- [Follow the code style guide](guides/code-style.md)
- [Use Docker locally](guides/docker.md)
- [Use the MCP server](guides/mcp-server.md)
- [Integrate via API or MCP](guides/api-integration.md)
- [Monitor and trace requests](guides/observability.md)
- [Measure quality (evals)](guides/evals.md)
- [Development lifecycle (SDLC)](sdlc.md)

### Understand the architecture

- [System overview](architecture/overview.md)
- [Server — Express API, agent loop, providers](architecture/server.md)
- [Agent memory — cross-session memory, observations, facts](architecture/agent-memory.md)
- [Search — BM25, HNSW, RRF, glossary](architecture/search.md)
- [Platform — auth, tenancy, permissions](architecture/platform.md)
- [Sandbox — isolated code execution](architecture/sandbox.md)
- [Data model — Prisma schema](architecture/data-model.md)
- [Offline client — sync, cursor pagination (design spec)](decisions/prds/offline-client-cursor-pagination.md) — detailed technical design in git history (`docs/architecture/offline-client.md`)

### Look up an API

- [Server REST API](api/server.md)
- [Platform RPC API](api/platform.md)
- [Sandbox engine API](api/sandbox.md)
- [Tool catalog](api/tool-catalog.md)

### Deploy or operate

- [Infrastructure — Terraform modules, environments](operations/infrastructure.md)
- [Platform infrastructure — Fargate topology, DB, DR](operations/platform-infrastructure.md)
- [Deployment pipeline](operations/deployment.md)
- [Ephemeral environments](operations/ephemeral-environments.md)
- [Runbook — common issues](operations/runbook.md)
- [Platform runbooks](operations/runbooks/) (incident response, key rotation, tenant onboarding, ...)
- [Sandbox runbooks](operations/runbooks/) (development, testing, troubleshooting)
- [Snowflake views — publishing and consumption](snowflake-views.md)

### Understand a decision

- [Decision index — TRDs, ADRs, PRDs](decisions/README.md)
- [Roadmap](roadmap.md)
- [Todos](todos.md)

### Research & comparisons

- [Comparisons overview — search, knowledge, memory, MCP](reference/comparisons/README.md)
- [MCP ecosystem comparison](reference/mcp-server-comparison.md)

### Security & compliance

- [Security model](compliance/security.md)
- [Threat model (STRIDE)](compliance/threat-model.md)
- [Compliance matrix](compliance/compliance-matrix.md)
- [Data processing record (GDPR Art. 30)](compliance/data-processing.md)
- [Data retention policy](compliance/data-retention.md)
- [Agent safety & guardrails](compliance/agent-safety.md)
- [Sandbox security](compliance/sandbox-security.md)