mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-05-05 09:46:30 +00:00
ci: fix sonarqube config and test suite failures
This commit is contained in:
diegosouzapw
parent
34bcb2b609
commit
5085dcf96f
138 changed files with 23558 additions and 33981 deletions
|
|
@ -4,11 +4,9 @@
|
|||
|
||||
---
|
||||
|
||||
> **Agent-to-Agent Protocol v0.3** — Enables any AI agent to use OmniRoute as an intelligent routing agent via JSON-RPC 2.0.
|
||||
> **Agent-to-Agent Protocol v0.3**— Umožňuje jakémukoli agentovi AI používat OmniRoute jako inteligentního směrovacího agenta prostřednictvím JSON-RPC 2.0.
|
||||
|
||||
The A2A Server exposes OmniRoute as a **first-class agent** that other agents can discover, delegate tasks to, and collaborate with using the [A2A Protocol](https://google.github.io/A2A/).
|
||||
|
||||
---
|
||||
Server A2A odhaluje OmniRoute jako**prvotřídního agenta**, kterého mohou ostatní agenti objevit, delegovat na něj úkoly a spolupracovat s ním pomocí [Protokol A2A](https://google.github.io/A2A/).---
|
||||
|
||||
## Architektura
|
||||
|
||||
|
|
@ -43,15 +41,12 @@ The A2A Server exposes OmniRoute as a **first-class agent** that other agents ca
|
|||
|
||||
### Agent Discovery
|
||||
|
||||
Every A2A-compatible agent exposes an **Agent Card** at `/.well-known/agent.json`:
|
||||
|
||||
```bash
|
||||
Každý agent kompatibilní s A2A vystaví**Kartu agenta**na `/.well-known/agent.json`:```bash
|
||||
curl http://localhost:20128/.well-known/agent.json
|
||||
```
|
||||
|
||||
**Response:**
|
||||
````
|
||||
|
||||
```json
|
||||
**Odpověď:**```json
|
||||
{
|
||||
"name": "OmniRoute",
|
||||
"description": "Intelligent AI gateway with auto-routing across 50+ providers",
|
||||
|
|
@ -88,7 +83,7 @@ curl http://localhost:20128/.well-known/agent.json
|
|||
"apiKeyHeader": "Authorization"
|
||||
}
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -96,27 +91,24 @@ curl http://localhost:20128/.well-known/agent.json
|
|||
|
||||
### `message/send` — Synchronous Execution
|
||||
|
||||
Send a message to a skill and receive the complete response.
|
||||
|
||||
```bash
|
||||
Pošlete zprávu dovednosti a obdržíte úplnou odpověď.```bash
|
||||
curl -X POST http://localhost:20128/a2a \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer YOUR_KEY" \
|
||||
-d '{
|
||||
"jsonrpc": "2.0",
|
||||
"id": "1",
|
||||
"method": "message/send",
|
||||
"params": {
|
||||
"skill": "smart-routing",
|
||||
"messages": [{"role": "user", "content": "Write a Python hello world"}],
|
||||
"metadata": {"model": "auto", "combo": "fast-coding"}
|
||||
}
|
||||
}'
|
||||
```
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer YOUR_KEY" \
|
||||
-d '{
|
||||
"jsonrpc": "2.0",
|
||||
"id": "1",
|
||||
"method": "message/send",
|
||||
"params": {
|
||||
"skill": "smart-routing",
|
||||
"messages": [{"role": "user", "content": "Write a Python hello world"}],
|
||||
"metadata": {"model": "auto", "combo": "fast-coding"}
|
||||
}
|
||||
}'
|
||||
|
||||
**Response:**
|
||||
````
|
||||
|
||||
```json
|
||||
**Odpověď:**```json
|
||||
{
|
||||
"jsonrpc": "2.0",
|
||||
"id": "1",
|
||||
|
|
@ -133,36 +125,33 @@ curl -X POST http://localhost:20128/a2a \
|
|||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
### `message/stream` — SSE Streaming
|
||||
|
||||
Same as `message/send` but returns Server-Sent Events for real-time streaming.
|
||||
|
||||
```bash
|
||||
Stejné jako `zpráva/odeslat`, ale vrací události odeslané serverem pro streamování v reálném čase.```bash
|
||||
curl -N -X POST http://localhost:20128/a2a \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer YOUR_KEY" \
|
||||
-d '{
|
||||
"jsonrpc": "2.0",
|
||||
"id": "1",
|
||||
"method": "message/stream",
|
||||
"params": {
|
||||
"skill": "smart-routing",
|
||||
"messages": [{"role": "user", "content": "Explain quantum computing"}]
|
||||
}
|
||||
}'
|
||||
```
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer YOUR_KEY" \
|
||||
-d '{
|
||||
"jsonrpc": "2.0",
|
||||
"id": "1",
|
||||
"method": "message/stream",
|
||||
"params": {
|
||||
"skill": "smart-routing",
|
||||
"messages": [{"role": "user", "content": "Explain quantum computing"}]
|
||||
}
|
||||
}'
|
||||
|
||||
**SSE Events:**
|
||||
````
|
||||
|
||||
```
|
||||
**Události SSE:**```
|
||||
data: {"jsonrpc":"2.0","method":"message/stream","params":{"task":{"id":"...","state":"working"},"chunk":{"type":"text","content":"Quantum computing..."}}}
|
||||
|
||||
: heartbeat 2026-03-04T21:00:00Z
|
||||
|
||||
data: {"jsonrpc":"2.0","method":"message/stream","params":{"task":{"id":"...","state":"completed"},"metadata":{...}}}
|
||||
```
|
||||
````
|
||||
|
||||
### `tasks/get` — Query Task Status
|
||||
|
||||
|
|
@ -188,40 +177,36 @@ curl -X POST http://localhost:20128/a2a \
|
|||
|
||||
### `smart-routing`
|
||||
|
||||
Routes prompts through OmniRoute's intelligent pipeline with full observability.
|
||||
Výzvy k trasování prostřednictvím inteligentního potrubí OmniRoute s plnou pozorovatelností.
|
||||
|
||||
**Parameters (in `metadata`):**
|
||||
**Parametry (v `metadatech`):**
|
||||
|
||||
| Parameter | Type | Default | Description |
|
||||
| --------- | -------- | ------------ | ---------------------------------------------------------------------------------------- |
|
||||
| `model` | `string` | `"auto"` | Target model (e.g., `claude-sonnet-4`, `gpt-4o`, `auto`) |
|
||||
| `combo` | `string` | active combo | Specific combo to route through |
|
||||
| `budget` | `number` | none | Maximum cost in USD for this request |
|
||||
| `role` | `string` | none | Task role hint: `coding`, `review`, `planning`, `analysis`, `debugging`, `documentation` |
|
||||
| Parametr | Typ | Výchozí | Popis |
|
||||
| ---------- | --------- | ------------- | --------------------------------------------------------------------------------------------- |
|
||||
| "modelka" | "řetězec" | "auto" | Cílový model (např. `claude-sonnet-4`, `gpt-4o`, `auto`) |
|
||||
| "kombo" | "řetězec" | aktivní kombo | Specifická kombinace pro trasu přes |
|
||||
| "rozpočet" | "číslo" | žádný | Maximální cena v USD pro tento požadavek |
|
||||
| "role" | "řetězec" | žádný | Nápověda k roli úlohy: `kódování`, `recenze`, `plánování`, `analýza`, `ladění`, `dokumentace` |
|
||||
|
||||
**Returns:**
|
||||
**Návraty:**
|
||||
|
||||
| Field | Description |
|
||||
| ------------------------------ | --------------------------------------------------------- |
|
||||
| `artifacts[].content` | The LLM response text |
|
||||
| `metadata.routing_explanation` | Human-readable explanation of routing decision |
|
||||
| `metadata.cost_envelope` | Estimated vs actual cost with currency |
|
||||
| `metadata.resilience_trace` | Array of events (primary_selected, fallback_needed, etc.) |
|
||||
| `metadata.policy_verdict` | Whether the request was allowed and why |
|
||||
| Pole | Popis |
|
||||
| ------------------------------ | ------------------------------------------------------ | ---------------------- |
|
||||
| `artefakty[].obsah` | Text odpovědi LLM |
|
||||
| `metadata.routing_explanation` | Lidsky čitelné vysvětlení rozhodnutí o směrování |
|
||||
| `metadata.cost_envelope` | Odhadované versus skutečné náklady s měnou |
|
||||
| `metadata.resilience_trace` | Pole událostí (primary_selected, fallback_needed atd.) |
|
||||
| `metadata.policy_verdict` | Zda byl požadavek povolen a proč | ### `quota-management` |
|
||||
|
||||
### `quota-management`
|
||||
Odpovídá na dotazy v přirozeném jazyce ohledně kvót poskytovatelů.
|
||||
|
||||
Answers natural-language queries about provider quotas.
|
||||
**Typy dotazů (odvozeno z obsahu zprávy):**
|
||||
|
||||
**Query types (inferred from message content):**
|
||||
|
||||
| Query Pattern | Response Type |
|
||||
| ---------------------------------------------- | -------------------------------------------------------- |
|
||||
| Contains `"ranking"`, `"most quota"`, `"best"` | Providers ranked by remaining quota |
|
||||
| Contains `"free"`, `"suggest"` | Lists free combos or suggests free-tier providers |
|
||||
| Default | Full quota summary with warnings for low-quota providers |
|
||||
|
||||
---
|
||||
| Vzor dotazu | Typ odezvy |
|
||||
| -------------------------------------------------------- | ------------------------------------------------------------------- | --- |
|
||||
| Obsahuje `"hodnocení"`, `"největší kvóta"`, `"nejlepší"` | Poskytovatelé seřazení podle zbývající kvóty |
|
||||
| Obsahuje `"zdarma"`, `"navrhnout"` | Vypisuje volná komba nebo navrhuje poskytovatele volné úrovně |
|
||||
| Výchozí | Úplný souhrn kvót s upozorněním pro poskytovatele s nízkými kvótami | --- |
|
||||
|
||||
## Task Lifecycle
|
||||
|
||||
|
|
@ -231,19 +216,17 @@ submitted ──→ working ──→ completed
|
|||
──────────→ cancelled
|
||||
```
|
||||
|
||||
| State | Description |
|
||||
| ----------- | ----------------------------------------------------- |
|
||||
| `submitted` | Task created, queued for execution |
|
||||
| `working` | Skill handler is executing |
|
||||
| `completed` | Execution succeeded, artifacts available |
|
||||
| `failed` | Execution failed or task expired (TTL: 5 min default) |
|
||||
| `cancelled` | Cancelled by client via `tasks/cancel` |
|
||||
| stát | Popis |
|
||||
| ----------- | ------------------------------------------------------------------------ |
|
||||
| "odesláno" | Úloha vytvořena, ve frontě k provedení |
|
||||
| "pracovní" | Skill handler provádí |
|
||||
| "dokončeno" | Provedení bylo úspěšné, artefakty jsou k dispozici |
|
||||
| "neúspěšné" | Provedení se nezdařilo nebo vypršela platnost úlohy (TTL: výchozí 5 min) |
|
||||
| "zrušeno" | Zrušeno klientem přes `tasks/cancel` |
|
||||
|
||||
- Terminal states: `completed`, `failed`, `cancelled` (no further transitions)
|
||||
- Expired tasks in `submitted` or `working` are auto-marked as `failed`
|
||||
- Tasks are garbage-collected after 2× TTL
|
||||
|
||||
---
|
||||
- Stavy terminálu: "dokončeno", "neúspěšné", "zrušeno" (žádné další přechody)
|
||||
– Úkoly s prošlou platností v `odesláno` nebo `pracovní` jsou automaticky označeny jako `neúspěšné`
|
||||
- Úkoly jsou sbírány po 2× TTL---
|
||||
|
||||
## Client Examples
|
||||
|
||||
|
|
@ -541,15 +524,12 @@ func main() {
|
|||
|
||||
### 🤖 Use Case 1: Multi-Agent Coding Pipeline
|
||||
|
||||
An orchestrator agent delegates code generation to OmniRoute, then passes the output to a review agent.
|
||||
|
||||
```python
|
||||
def coding_pipeline(task: str):
|
||||
# Step 1: Generate code via OmniRoute A2A
|
||||
code_result = a2a_send("smart-routing", [
|
||||
{"role": "user", "content": f"Write production-quality code: {task}"}
|
||||
], metadata={"model": "auto", "role": "coding"})
|
||||
code = code_result["artifacts"][0]["content"]
|
||||
Agent orchestrátoru deleguje generování kódu na OmniRoute a poté předá výstup kontrolnímu agentovi.```python
|
||||
def coding_pipeline(task: str): # Step 1: Generate code via OmniRoute A2A
|
||||
code_result = a2a_send("smart-routing", [
|
||||
{"role": "user", "content": f"Write production-quality code: {task}"}
|
||||
], metadata={"model": "auto", "role": "coding"})
|
||||
code = code_result["artifacts"][0]["content"]
|
||||
|
||||
# Step 2: Review the code via OmniRoute A2A (different model)
|
||||
review_result = a2a_send("smart-routing", [
|
||||
|
|
@ -562,13 +542,12 @@ def coding_pipeline(task: str):
|
|||
print(f"Review cost: ${review_result['metadata']['cost_envelope']['actual']}")
|
||||
|
||||
return {"code": code, "review": review}
|
||||
```
|
||||
|
||||
````
|
||||
|
||||
### 💡 Use Case 2: Quota-Aware Agent Swarm
|
||||
|
||||
Multiple agents share quota through OmniRoute, using the quota skill to coordinate.
|
||||
|
||||
```python
|
||||
Více agentů sdílí kvóty prostřednictvím OmniRoute, přičemž ke koordinaci využívá dovednost kvót.```python
|
||||
async def quota_aware_agent(agent_name: str, task: str):
|
||||
# Check quota before starting
|
||||
quota = a2a_send("quota-management", [
|
||||
|
|
@ -591,32 +570,30 @@ async def quota_aware_agent(agent_name: str, task: str):
|
|||
print(f"[{agent_name}] Free alternatives: {quota['artifacts'][0]['content']}")
|
||||
|
||||
return result
|
||||
```
|
||||
````
|
||||
|
||||
### 📊 Use Case 3: Real-Time Streaming Dashboard
|
||||
|
||||
A monitoring agent streams responses and displays progress in real-time.
|
||||
|
||||
```typescript
|
||||
Monitorovací agent streamuje odpovědi a zobrazuje průběh v reálném čase.```typescript
|
||||
async function streamingDashboard(prompt: string) {
|
||||
const response = await fetch(`${BASE_URL}/a2a`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json", Authorization: `Bearer ${API_KEY}` },
|
||||
body: JSON.stringify({
|
||||
jsonrpc: "2.0",
|
||||
id: "dash-1",
|
||||
method: "message/stream",
|
||||
params: { skill: "smart-routing", messages: [{ role: "user", content: prompt }] },
|
||||
}),
|
||||
});
|
||||
body: JSON.stringify({
|
||||
jsonrpc: "2.0",
|
||||
id: "dash-1",
|
||||
method: "message/stream",
|
||||
params: { skill: "smart-routing", messages: [{ role: "user", content: prompt }] },
|
||||
}),
|
||||
});
|
||||
|
||||
let totalChunks = 0;
|
||||
const reader = response.body!.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
let totalChunks = 0;
|
||||
const reader = response.body!.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
for (const line of decoder.decode(value).split("\n")) {
|
||||
if (line.startsWith("data: ")) {
|
||||
|
|
@ -640,15 +617,15 @@ async function streamingDashboard(prompt: string) {
|
|||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
```
|
||||
}
|
||||
|
||||
````
|
||||
|
||||
### 🔁 Use Case 4: Task Polling Pattern
|
||||
|
||||
For long-running tasks, poll the task status instead of waiting synchronously.
|
||||
|
||||
```python
|
||||
U dlouhotrvajících úloh namísto synchronního čekání zjistěte stav úlohy.```python
|
||||
import time
|
||||
|
||||
def poll_task(task_id: str, timeout: int = 60):
|
||||
|
|
@ -678,75 +655,71 @@ def poll_task(task_id: str, timeout: int = 60):
|
|||
"params": {"taskId": task_id},
|
||||
})
|
||||
raise TimeoutError(f"Task {task_id} timed out after {timeout}s")
|
||||
```
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
## Error Codes
|
||||
|
||||
| Code | Constant | Meaning |
|
||||
| ------ | ------------------------ | ---------------------------------------- |
|
||||
| -32700 | — | Parse error (invalid JSON) |
|
||||
| -32600 | `INVALID_REQUEST` | Invalid JSON-RPC request or unauthorized |
|
||||
| -32601 | `METHOD_NOT_FOUND` | Unknown method or skill |
|
||||
| -32602 | `INVALID_PARAMS` | Missing or invalid parameters |
|
||||
| -32603 | `INTERNAL_ERROR` | Skill execution failed |
|
||||
| -32001 | `TASK_NOT_FOUND` | Task ID not found |
|
||||
| -32002 | `TASK_ALREADY_COMPLETED` | Cannot modify a completed task |
|
||||
| -32003 | `UNAUTHORIZED` | Invalid or missing API key |
|
||||
| -32004 | `BUDGET_EXCEEDED` | Request exceeds configured budget |
|
||||
| -32005 | `PROVIDER_UNAVAILABLE` | No available providers |
|
||||
|
||||
---
|
||||
| Kód | Konstantní | Význam |
|
||||
| ------ | ------------------------ | ----------------------------------------------- | --- |
|
||||
| -32700 | — | Chyba analýzy (neplatný JSON) |
|
||||
| -32600 | `INVALID_REQUEST` | Neplatný požadavek JSON-RPC nebo neautorizovaný |
|
||||
| -32601 | `METHOD_NOT_FOUND` | Neznámá metoda nebo dovednost |
|
||||
| -32602 | `INVALID_PARAMS` | Chybějící nebo neplatné parametry |
|
||||
| -32603 | `INTERNAL_ERROR` | Provedení dovednosti se nezdařilo |
|
||||
| -32001 | `TASK_NOT_FOUND` | ID úlohy nenalezeno |
|
||||
| -32002 | `TASK_ALREADY_COMPLETED` | Nelze upravit dokončený úkol |
|
||||
| -32003 | "NEPOVOLENO" | Neplatný nebo chybějící klíč API |
|
||||
| -32004 | `BUDGET_EXCEEDED` | Požadavek překračuje nastavený rozpočet |
|
||||
| -32005 | `PROVIDER_UNAVAILABLE` | Žádní dostupní poskytovatelé | --- |
|
||||
|
||||
## Authentication
|
||||
|
||||
All `/a2a` requests require a Bearer token via the `Authorization` header:
|
||||
|
||||
```
|
||||
Všechny požadavky `/a2a` vyžadují token nosiče prostřednictvím záhlaví `Authorization`:```
|
||||
Authorization: Bearer YOUR_OMNIROUTE_API_KEY
|
||||
|
||||
```
|
||||
|
||||
If no API key is configured on the server (`OMNIROUTE_API_KEY` is empty), authentication is bypassed.
|
||||
|
||||
---
|
||||
Pokud na serveru není nakonfigurován žádný klíč API (`OMNIROUTE_API_KEY` je prázdný), ověřování je vynecháno.---
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
|
||||
src/lib/a2a/
|
||||
├── taskManager.ts # Task lifecycle (create/update/cancel/list), TTL, cleanup
|
||||
├── taskExecution.ts # Generic task executor with state management
|
||||
├── streaming.ts # SSE stream formatting, heartbeat, chunk/completion events
|
||||
├── routingLogger.ts # Routing decision logger (stats, history, retention)
|
||||
├── taskManager.ts # Task lifecycle (create/update/cancel/list), TTL, cleanup
|
||||
├── taskExecution.ts # Generic task executor with state management
|
||||
├── streaming.ts # SSE stream formatting, heartbeat, chunk/completion events
|
||||
├── routingLogger.ts # Routing decision logger (stats, history, retention)
|
||||
└── skills/
|
||||
├── smartRouting.ts # Smart routing skill (routes via /v1/chat/completions)
|
||||
└── quotaManagement.ts # Quota management skill (natural-language quota queries)
|
||||
├── smartRouting.ts # Smart routing skill (routes via /v1/chat/completions)
|
||||
└── quotaManagement.ts # Quota management skill (natural-language quota queries)
|
||||
|
||||
src/app/a2a/
|
||||
└── route.ts # Next.js API route handler (JSON-RPC 2.0 dispatch)
|
||||
└── route.ts # Next.js API route handler (JSON-RPC 2.0 dispatch)
|
||||
|
||||
open-sse/mcp-server/
|
||||
└── schemas/a2a.ts # Zod schemas (AgentCard, Task, JSON-RPC, SSE events)
|
||||
└── schemas/a2a.ts # Zod schemas (AgentCard, Task, JSON-RPC, SSE events)
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Comparison: MCP vs A2A
|
||||
|
||||
| Feature | MCP Server | A2A Server |
|
||||
| ----------------- | ---------------------------- | ------------------------------------------------- |
|
||||
| **Protocol** | Model Context Protocol | Agent-to-Agent Protocol v0.3 |
|
||||
| **Transport** | stdio / HTTP | HTTP (JSON-RPC 2.0) |
|
||||
| **Discovery** | Tool listing via MCP | `/.well-known/agent.json` |
|
||||
| **Granularity** | 16 individual tools | 2 high-level skills |
|
||||
| **Best for** | IDE agents (Cursor, VS Code) | Multi-agent systems (LangChain, CrewAI) |
|
||||
| **Streaming** | Not supported | SSE via `message/stream` |
|
||||
| **Task tracking** | No | Full lifecycle (submitted → completed) |
|
||||
| **Observability** | Audit log per tool call | Cost envelope + resilience trace + policy verdict |
|
||||
|
||||
---
|
||||
| Funkce | Server MCP | Server A2A |
|
||||
| ------------------ | ----------------------------- | -------------------------------------------------- |
|
||||
|**Protokol**| Protokol kontextu modelu | Agent-to-Agent Protocol v0.3 |
|
||||
|**Doprava**| stdio / HTTP | HTTP (JSON-RPC 2.0) |
|
||||
|**Objev**| Seznam nástrojů přes MCP | `/.well-known/agent.json` |
|
||||
|**Zrnitost**| 16 jednotlivých nástrojů | 2 dovednosti na vysoké úrovni |
|
||||
|**Nejlepší pro**| IDE agenti (kurzor, VS kód) | Multiagentní systémy (LangChain, CrewAI) |
|
||||
|**Streamování**| Není podporováno | SSE přes `zprávu/stream` |
|
||||
|**Sledování úkolů**| Ne | Celý životní cyklus (předloženo → dokončeno) |
|
||||
|**Pozorovatelnost**| Protokol auditu na volání nástroje | Obálka nákladů + sledování odolnosti + verdikt zásad |---
|
||||
|
||||
## Licence
|
||||
|
||||
Part of [OmniRoute](https://github.com/diegosouzapw/OmniRoute) — MIT License.
|
||||
Součást [OmniRoute](https://github.com/diegosouzapw/OmniRoute) — licence MIT.
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue