# karatelabs/karate-agent-examples architecture

> Architecture diagram of the GitHub repository karatelabs/karate-agent-examples, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/karatelabs/karate-agent-examples
- Repository: https://github.com/karatelabs/karate-agent-examples

## Overview

This repository is a collection of runnable Karate Agent evaluation kits, not the governance engine itself. The principal workflow is that a human or AI agent runs a kit, whose checks exercise a sample system and whose evidence supports coverage or requirements-traceability reports. The graph preserves the README’s major kit capabilities and the sampled rulebook, mock, and server responsibilities. Several branches are documented in the README but their implementations were not sampled, so those links cite the README rather than imply inspection of their source.

Main entry points: [`traceability-demo`](https://github.com/karatelabs/karate-agent-examples/tree/main/traceability-demo) (Loan traceability kits), [`policy-api`](https://github.com/karatelabs/karate-agent-examples/tree/main/policy-api) (Policy API kit), [`fleetquote`](https://github.com/karatelabs/karate-agent-examples/tree/main/fleetquote) (Fleetquote kit), [`mcp`](https://github.com/karatelabs/karate-agent-examples/tree/main/mcp) (MCP example kit)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_trace["Traceability demos"]
  node_tracekits["Loan traceability kits"]
  node_loanrules["Personal-loan rules<br/>[calc.js]"]
  node_loansut["Loan Desk SUT<br/>[loan-calc.js]"]
  node_uicheck["Loan Desk UI check<br/>[drive-quote.js]"]
  node_kirokits["Kiro decision kit"]
  node_kirosut["Decision service<br/>[decision.js]"]
  node_fleetkit["Fleetquote kit"]
  node_ratingrules["Rating oracle<br/>[calc.js]"]
  node_lifetwin["Quote lifecycle twin<br/>[twin.js]"]
end

subgraph group_insurance["Insurance protocols"]
  node_policykit["Policy API kit"]
  node_policyboot["Protocol coverage setup<br/>[karate-boot.js]"]
  node_policytests["API and rule checks<br/>[suite.karate.js]"]
end

subgraph group_contracts["Contract testing"]
  node_checkoutkit["Checkout contract kit"]
  node_pairedrun["Mock-provider paired run<br/>[contract.karate.js]"]
end

subgraph group_protocols["Protocol examples"]
  node_protocolkits["Protocol test kits"]
  node_grpccontract["gRPC protocol contract<br/>[hello.proto]"]
  node_kafkakit["Kafka example"]
  node_websocketkit["WebSocket example"]
  node_stompbroker["STOMP broker<br/>[StompBroker.java]"]
end

subgraph group_mcp["MCP example"]
  node_mcpkit["MCP example kit"]
  node_mcpserver["Inventory MCP server<br/>[server.ts]"]
end

node_human(("Human or AI agent"))
node_engine["Karate Agent engine"]

node_human -->|"drives"| node_engine
node_engine -->|"runs kit"| node_tracekits
node_engine -->|"runs kit"| node_kirokits
node_engine -->|"runs kit"| node_fleetkit
node_engine -->|"runs kit"| node_policykit
node_engine -->|"runs kit"| node_checkoutkit
node_engine -->|"runs kit"| node_protocolkits
node_engine -->|"runs kit"| node_kafkakit
node_engine -->|"runs kit"| node_websocketkit
node_engine -->|"runs kit"| node_mcpkit
node_tracekits -->|"oracles with"| node_loanrules
node_tracekits -->|"checks against"| node_loansut
node_tracekits -->|"includes UI check"| node_uicheck
node_kirokits -->|"tests service"| node_kirosut
node_fleetkit -->|"grades rules"| node_ratingrules
node_fleetkit -->|"models lifecycle"| node_lifetwin
node_policykit -->|"configures coverage"| node_policyboot
node_policykit -->|"includes checks"| node_policytests
node_policykit -->|"reports traceability"| node_engine
node_checkoutkit -->|"pairs implementations"| node_pairedrun
node_pairedrun -->|"uses contract runner"| node_engine
node_protocolkits -->|"tests contract"| node_grpccontract
node_websocketkit -->|"includes server"| node_stompbroker
node_mcpkit -->|"tests server"| node_mcpserver
node_human -->|"can drive via MCP"| node_mcpkit
node_mcpserver -.->|"serves MCP tools"| node_engine

click node_tracekits "https://github.com/karatelabs/karate-agent-examples/tree/main/traceability-demo"
click node_loanrules "https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/rulebooks/personal-loan/calc.js"
click node_loansut "https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/sut/loan-calc.js"
click node_uicheck "https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/checks/drive-quote.js"
click node_kirokits "https://github.com/karatelabs/karate-agent-examples/tree/main/kiro-demo"
click node_kirosut "https://github.com/karatelabs/karate-agent-examples/blob/main/kiro-demo/sut/decision.js"
click node_fleetkit "https://github.com/karatelabs/karate-agent-examples/tree/main/fleetquote"
click node_ratingrules "https://github.com/karatelabs/karate-agent-examples/blob/main/fleetquote/rulebooks/rating/calc.js"
click node_lifetwin "https://github.com/karatelabs/karate-agent-examples/blob/main/fleetquote/rulebooks/rating/twin.js"
click node_policykit "https://github.com/karatelabs/karate-agent-examples/tree/main/policy-api"
click node_policyboot "https://github.com/karatelabs/karate-agent-examples/blob/main/policy-api/karate-boot.js"
click node_policytests "https://github.com/karatelabs/karate-agent-examples/blob/main/policy-api/suite.karate.js"
click node_checkoutkit "https://github.com/karatelabs/karate-agent-examples/tree/main/checkout"
click node_pairedrun "https://github.com/karatelabs/karate-agent-examples/blob/main/checkout/contract.karate.js"
click node_protocolkits "https://github.com/karatelabs/karate-agent-examples/tree/main/grpc"
click node_grpccontract "https://github.com/karatelabs/karate-agent-examples/blob/main/grpc/proto/hello.proto"
click node_kafkakit "https://github.com/karatelabs/karate-agent-examples/tree/main/kafka"
click node_websocketkit "https://github.com/karatelabs/karate-agent-examples/tree/main/websocket"
click node_stompbroker "https://github.com/karatelabs/karate-agent-examples/blob/main/websocket/server/StompBroker.java"
click node_mcpkit "https://github.com/karatelabs/karate-agent-examples/tree/main/mcp"
click node_mcpserver "https://github.com/karatelabs/karate-agent-examples/blob/main/mcp/server/src/server.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_tracekits,node_loanrules,node_loansut,node_uicheck,node_kirokits,node_kirosut,node_fleetkit,node_ratingrules,node_lifetwin toneBlue
class node_policykit,node_policyboot,node_policytests toneAmber
class node_checkoutkit,node_pairedrun toneMint
class node_protocolkits,node_grpccontract,node_kafkakit,node_websocketkit,node_stompbroker toneRose
class node_mcpkit,node_mcpserver,node_human,node_engine toneIndigo
```

## Components

### Traceability demos

- [Loan traceability kits](https://github.com/karatelabs/karate-agent-examples/tree/main/traceability-demo): `traceability-demo`
- [Personal-loan rules](https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/rulebooks/personal-loan/calc.js): `traceability-demo/rulebooks/personal-loan/calc.js`
- [Loan Desk SUT](https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/sut/loan-calc.js): `traceability-demo/sut/loan-calc.js`
- [Loan Desk UI check](https://github.com/karatelabs/karate-agent-examples/blob/main/traceability-demo/checks/drive-quote.js): `traceability-demo/checks/drive-quote.js`
- [Kiro decision kit](https://github.com/karatelabs/karate-agent-examples/tree/main/kiro-demo): `kiro-demo`
- [Decision service](https://github.com/karatelabs/karate-agent-examples/blob/main/kiro-demo/sut/decision.js): `kiro-demo/sut/decision.js`
- [Fleetquote kit](https://github.com/karatelabs/karate-agent-examples/tree/main/fleetquote): `fleetquote`
- [Rating oracle](https://github.com/karatelabs/karate-agent-examples/blob/main/fleetquote/rulebooks/rating/calc.js): `fleetquote/rulebooks/rating/calc.js`
- [Quote lifecycle twin](https://github.com/karatelabs/karate-agent-examples/blob/main/fleetquote/rulebooks/rating/twin.js): `fleetquote/rulebooks/rating/twin.js`

### Insurance protocols

- [Policy API kit](https://github.com/karatelabs/karate-agent-examples/tree/main/policy-api): `policy-api`
- [Protocol coverage setup](https://github.com/karatelabs/karate-agent-examples/blob/main/policy-api/karate-boot.js): `policy-api/karate-boot.js`
- [API and rule checks](https://github.com/karatelabs/karate-agent-examples/blob/main/policy-api/suite.karate.js): `policy-api/suite.karate.js`

### Contract testing

- [Checkout contract kit](https://github.com/karatelabs/karate-agent-examples/tree/main/checkout): `checkout`
- [Mock-provider paired run](https://github.com/karatelabs/karate-agent-examples/blob/main/checkout/contract.karate.js): `checkout/contract.karate.js`

### Protocol examples

- [Protocol test kits](https://github.com/karatelabs/karate-agent-examples/tree/main/grpc): `grpc`
- [gRPC protocol contract](https://github.com/karatelabs/karate-agent-examples/blob/main/grpc/proto/hello.proto): `grpc/proto/hello.proto`
- [Kafka example](https://github.com/karatelabs/karate-agent-examples/tree/main/kafka): `kafka`
- [WebSocket example](https://github.com/karatelabs/karate-agent-examples/tree/main/websocket): `websocket`
- [STOMP broker](https://github.com/karatelabs/karate-agent-examples/blob/main/websocket/server/StompBroker.java): `websocket/server/StompBroker.java`

### MCP example

- [MCP example kit](https://github.com/karatelabs/karate-agent-examples/tree/main/mcp): `mcp`
- [Inventory MCP server](https://github.com/karatelabs/karate-agent-examples/blob/main/mcp/server/src/server.ts): `mcp/server/src/server.ts`

### Other components

- **Human or AI agent**
- **Karate Agent engine**

## Connections

- Human or AI agent → Karate Agent engine: drives
- Karate Agent engine → Loan traceability kits: runs kit
- Karate Agent engine → Kiro decision kit: runs kit
- Karate Agent engine → Fleetquote kit: runs kit
- Karate Agent engine → Policy API kit: runs kit
- Karate Agent engine → Checkout contract kit: runs kit
- Karate Agent engine → Protocol test kits: runs kit
- Karate Agent engine → Kafka example: runs kit
- Karate Agent engine → WebSocket example: runs kit
- Karate Agent engine → MCP example kit: runs kit
- Loan traceability kits → Personal-loan rules: oracles with (evidence: `traceability-demo/checks/drive-quote.js`)
- Loan traceability kits → Loan Desk SUT: checks against (evidence: `traceability-demo/sut/loan-calc.js`)
- Loan traceability kits → Loan Desk UI check: includes UI check (evidence: `traceability-demo/karate-boot.js`)
- Kiro decision kit → Decision service: tests service (evidence: `kiro-demo/sut/decision.js`)
- Fleetquote kit → Rating oracle: grades rules (evidence: `fleetquote/suite.karate.js`)
- Fleetquote kit → Quote lifecycle twin: models lifecycle
- Policy API kit → Protocol coverage setup: configures coverage (evidence: `policy-api/karate-boot.js`)
- Policy API kit → API and rule checks: includes checks
- Policy API kit → Karate Agent engine: reports traceability (evidence: `policy-api/karate-boot.js`)
- Checkout contract kit → Mock-provider paired run: pairs implementations (evidence: `checkout/contract.karate.js`)
- Mock-provider paired run → Karate Agent engine: uses contract runner (evidence: `checkout/contract.karate.js`)
- Protocol test kits → gRPC protocol contract: tests contract
- WebSocket example → STOMP broker: includes server (evidence: `websocket/server/StompBroker.java`)
- MCP example kit → Inventory MCP server: tests server (evidence: `mcp/server/src/server.ts`)
- Human or AI agent → MCP example kit: can drive via MCP
- Inventory MCP server → Karate Agent engine: serves MCP tools
