diff --git a/README.md b/README.md index 5af193c..dd59718 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@

- Govyn
- Open-source AI agent governance proxy + + + + + Govyn + + +
+ Open-source AI agent governance proxy

@@ -27,18 +34,13 @@ SDK-based governance is enforced by convention, not architecture. It works only ## How Govyn Works -``` - Your Agent Govyn Proxy LLM Provider - +--------+ +-------------+ +-----------+ - | | proxy URL | | real API key | | - | Agent +------------------>+ 1. Auth +--------------->+ OpenAI | - | | (no real key) | 2. Policy | | Anthropic| - | | | 3. Budget | response | Google | - | |<------------------+ 4. Loop +<---------------+ Mistral | - | | response | 5. Route | | | - +--------+ | 6. Log | +-----------+ - +-------------+ -``` +

+ + + + Govyn Architecture — Agent sends requests to proxy, proxy enforces governance and forwards to LLM providers + +

1. **Agent sends request** — standard API call to the proxy URL. No knowledge of the real API key. 2. **Policy evaluation** — YAML-defined rules checked in-memory. Model restrictions, content filters, human approval queues. diff --git a/docs/assets/architecture-dark.svg b/docs/assets/architecture-dark.svg new file mode 100644 index 0000000..0ba09b3 --- /dev/null +++ b/docs/assets/architecture-dark.svg @@ -0,0 +1,85 @@ + + + + + + + + + + Your Agent + + Sends requests + to proxy URL + (no real API key) + + + + Govyn Proxy + + + + + 1 + Auth + + + + 2 + Policy Evaluation + + + + 3 + Budget Check + + + + 4 + Loop Detection + + + + 5 + Smart Routing + + + + 6 + Forward & Log + + + + LLM Providers + + OpenAI + Anthropic + Google + Mistral + + + + + + + + proxy URL + + + + + + response + + + + + + real API key + + + + + + response + diff --git a/docs/assets/architecture-light.svg b/docs/assets/architecture-light.svg new file mode 100644 index 0000000..8743468 --- /dev/null +++ b/docs/assets/architecture-light.svg @@ -0,0 +1,85 @@ + + + + + + + + + + Your Agent + + Sends requests + to proxy URL + (no real API key) + + + + Govyn Proxy + + + + + 1 + Auth + + + + 2 + Policy Evaluation + + + + 3 + Budget Check + + + + 4 + Loop Detection + + + + 5 + Smart Routing + + + + 6 + Forward & Log + + + + LLM Providers + + OpenAI + Anthropic + Google + Mistral + + + + + + + + proxy URL + + + + + + response + + + + + + real API key + + + + + + response +