pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-07-26 09:52:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs(wiki): sync counts to v3.8.24 — 226 providers, 15 strategies, 87 MCP tools, 42 locales

diegosouzapw
2026-06-13 20:47:15 -03:00
parent 3b4d357bec
commit 9517ae7e1b
12 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Architecture.md

@@ -14,7 +14,7 @@ It provides a single OpenAI-compatible endpoint (`/v1/*`) and routes traffic acr
Core capabilities:
- OpenAI-compatible API surface for CLI/tools (177 providers, 38 executors)
- OpenAI-compatible API surface for CLI/tools (226 providers, 38 executors)
- Request/response translation across provider formats
- Model combo fallback (multi-model sequence)
- Structured combo steps (`provider + model + connection`) with runtime ordering by `compositeTiers`
@@ -55,7 +55,7 @@ Core capabilities:
- Compliance audit logging with opt-out per API key
- Eval framework for LLM quality assurance
- Health dashboard with real-time provider circuit breaker status
- MCP Server (37 tools) with 3 transports (stdio/SSE/Streamable HTTP)
- MCP Server (87 tools) with 3 transports (stdio/SSE/Streamable HTTP)
- A2A Server (JSON-RPC 2.0 + SSE) with skills and task lifecycle
- Memory system (extraction, injection, retrieval, summarization)
- Skills system (registry, executor, sandbox, built-in skills)
@@ -339,7 +339,7 @@ relying on a static combo definition. It powers the `auto/*` model prefix family
Key capabilities:
- **14 routing strategies** (priority, weighted, fill-first, round-robin, P2C, random,
- **15 routing strategies** (priority, weighted, fill-first, round-robin, P2C, random,
least-used, cost-optimized, strict-random, **auto**, lkgp, context-optimized,
context-relay, plus a fallback path) — auto is the headline addition in v3.8.0.
- **9-factor scoring**: cost, latency p95, success rate, quota headroom, lockout

4
Auto-Combo.md

@@ -123,7 +123,7 @@ Notes:
## All Routing Strategies
OmniRoute's combo engine supports **14 routing strategies** (declared in `src/shared/constants/routingStrategies.ts` → `ROUTING_STRATEGY_VALUES`). The Auto Combo engine itself is exposed under the `auto` strategy; the others are available for persisted combos.
OmniRoute's combo engine supports **15 routing strategies** (declared in `src/shared/constants/routingStrategies.ts` → `ROUTING_STRATEGY_VALUES`). The Auto Combo engine itself is exposed under the `auto` strategy; the others are available for persisted combos.
| Strategy | Description |
| :------------------ | :----------------------------------------------------------------- |
@@ -245,5 +245,5 @@ See `docs/marketing/TIERS.md` for tier definitions and provider classification.
| `open-sse/services/autoCombo/autoPrefix.ts` | `auto/` prefix parser + 6 variants |
| `open-sse/services/autoCombo/virtualFactory.ts` | Builds in-memory `AutoComboConfig` from live connections |
| `open-sse/services/autoCombo/providerRegistryAccessor.ts` | Test hook for mocking provider registry |
| `src/shared/constants/routingStrategies.ts` | `ROUTING_STRATEGY_VALUES` (14 strategies) |
| `src/shared/constants/routingStrategies.ts` | `ROUTING_STRATEGY_VALUES` (15 strategies) |
| `src/sse/handlers/chat.ts` | Integration: auto-prefix short-circuit |

2
Codebase-Documentation.md

@@ -481,7 +481,7 @@ Highlights (full list under `open-sse/services/`):
| Concern | Files |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Combo routing | `combo.ts` (14 strategies), `comboConfig.ts`, `comboMetrics.ts`, `comboManifestMetrics.ts`, `comboAgentMiddleware.ts` |
| Combo routing | `combo.ts` (15 strategies), `comboConfig.ts`, `comboMetrics.ts`, `comboManifestMetrics.ts`, `comboAgentMiddleware.ts` |
| Auto Combo engine | `autoCombo/` — `engine.ts`, `scoring.ts`, `taskFitness.ts`, `virtualFactory.ts`, `modePacks.ts`, `autoPrefix.ts`, `persistence.ts`, `providerDiversity.ts`, `providerRegistryAccessor.ts`, `routerStrategy.ts`, `selfHealing.ts`, `index.ts` |
| Resilience | `accountFallback.ts` (cooldown + lockout), `errorClassifier.ts`, `emergencyFallback.ts`, `rateLimitManager.ts`, `rateLimitSemaphore.ts`, `accountSemaphore.ts`, `accountSelector.ts` |
| Quotas | `quotaMonitor.ts`, `quotaPreflight.ts`, `bailianQuotaFetcher.ts`, `codexQuotaFetcher.ts`, `deepseekQuotaFetcher.ts`, `crofUsageFetcher.ts`, `antigravityCredits.ts` |

2
Contributing.md

@@ -210,7 +210,7 @@ src/ # TypeScript (.ts / .tsx)
├── mitm/ # MITM proxy (cert, DNS, target routing)
├── shared/
│ ├── components/ # React components (.tsx)
│ ├── constants/ # Provider definitions (177), MCP scopes, 14 routing strategies
│ ├── constants/ # Provider definitions (177), MCP scopes, 15 routing strategies
│ ├── utils/ # Circuit breaker, sanitizer, auth helpers
│ └── validation/ # Zod v4 schemas
└── sse/ # SSE proxy pipeline

2
Features.md

@@ -56,7 +56,7 @@ Manage AI provider connections: OAuth providers (Claude Code, Codex, Gemini CLI)
## 🎨 Combos
Create model routing combos with 14 strategies: priority, weighted, fill-first, round-robin, p2c (power-of-two-choices), random, least-used, cost-optimized, reset-aware, strict-random, auto, lkgp (last-known-good-provider), context-optimized, and **context-relay**. Each combo chains multiple models with automatic fallback and includes quick templates and readiness checks.
Create model routing combos with 15 strategies: priority, weighted, fill-first, round-robin, p2c (power-of-two-choices), random, least-used, cost-optimized, reset-aware, strict-random, auto, lkgp (last-known-good-provider), context-optimized, and **context-relay**. Each combo chains multiple models with automatic fallback and includes quick templates and readiness checks.
Recent combo improvements:

10
Home.md

@@ -1,6 +1,6 @@
# 🚀 OmniRoute — The Free AI Gateway
**Never stop coding. Connect every AI tool to 212+ providers — 50+ free — through one endpoint.**
**Never stop coding. Connect every AI tool to 226 providers — 50+ free — through one endpoint.**
Plug Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude / GPT / Gemini. Auto-fallback.
@@ -12,11 +12,11 @@ Plug Claude Code, Codex, Cursor, Cline, Copilot & Antigravity into FREE Claude /
| Feature | Description |
|---------|-------------|
| **212+ AI Providers** | OpenAI, Anthropic, Gemini, DeepSeek, Groq, xAI, Mistral, and many more |
| **226 AI Providers** | OpenAI, Anthropic, Gemini, DeepSeek, Groq, xAI, Mistral, and many more |
| **50+ Free Tiers** | OAuth + free-tier providers for zero-cost AI access |
| **14 Routing Strategies** | Priority, weighted, round-robin, cost-optimized, context-relay, and more |
| **15 Routing Strategies** | Priority, weighted, round-robin, cost-optimized, context-relay, and more |
| **Token Compression** | RTK + Caveman engines save 15–95% tokens automatically |
| **MCP Server** | 37 tools with stdio/SSE/Streamable HTTP transports |
| **MCP Server** | 87 tools with stdio/SSE/Streamable HTTP transports |
| **A2A Protocol** | JSON-RPC 2.0 agent-to-agent communication |
| **Electron App** | Cross-platform desktop app (Windows, macOS, Linux) |
| **40+ Languages** | Full i18n support across the dashboard |
@@ -42,7 +42,7 @@ Use the **sidebar** to navigate through all documentation sections:
- **[Features](Features)** — All features explained
- **[Architecture](Architecture)** — System design and internals
- **[API Reference](API-Reference)** — REST API documentation
- **[Providers](Provider-Reference)** — All 212+ supported providers
- **[Providers](Provider-Reference)** — All 226 supported providers
- **[Combos & Routing](Auto-Combo)** — Routing strategies
- **[Compression](Compression-Guide)** — Token compression pipeline
- **[MCP Server](MCP-Server)** — MCP tools and transports

6
MCP-Server.md

@@ -3,11 +3,11 @@
# OmniRoute MCP Server Documentation
> Model Context Protocol server with 37 tools across routing, cache, compression, memory, skills, and proxy operations.
> Model Context Protocol server with 87 tools across routing, cache, compression, memory, skills, and proxy operations.
>
> Source of truth: `open-sse/mcp-server/schemas/tools.ts` (30 tools) + `open-sse/mcp-server/tools/memoryTools.ts` (3 tools) + `open-sse/mcp-server/tools/skillTools.ts` (4 tools). Tool registration and scope wiring lives in `open-sse/mcp-server/server.ts`.
![MCP tool inventory (37 tools by category)](../diagrams/exported/mcp-tools-37.svg)
![MCP tool inventory (87 tools by category)](../diagrams/exported/mcp-tools-37.svg)
> Source: [diagrams/mcp-tools-37.mmd](../diagrams/mcp-tools-37.mmd)
@@ -174,7 +174,7 @@ Defined in `open-sse/mcp-server/tools/skillTools.ts`. Backed by `src/lib/skills/
## Related Frameworks (v3.8.0)
The MCP tool inventory above (37 tools = 30 base + 3 memory + 4 skills) is intentionally
The MCP tool inventory above (87 tools = 30 base + 3 memory + 4 skills) is intentionally
scoped to runtime routing/cache/compression/memory/skills/proxy operations. Two adjacent
frameworks ship alongside the MCP server in v3.8.0 and are documented separately:

4
OmniRoute-vs-Alternatives.md

@@ -13,10 +13,10 @@ Objective feature comparison vs popular open-source AI routers.
| **Providers** | **207+** | ~100 | ~50 | ~30 |
| **Self-hostable** | ✅ | ✅ | ❌ | ⚠ paid |
| **OAuth providers (Claude, Codex, Copilot, etc.)** | **15+** | partial | ❌ | ❌ |
| **Auto-fallback combos** | **14 strategies** | priority-based | tier-based | weighted |
| **Auto-fallback combos** | **15 strategies** | priority-based | tier-based | weighted |
| **Tier 1/2/3 fallback (subscription→cheap→free)** | ✅ + UI | manual | n/a | manual |
| **Token compression** | RTK (47 filters) + Caveman | none | none | none |
| **Built-in MCP server** | ✅ 37 tools, 13 scopes | ❌ | ❌ | ❌ |
| **Built-in MCP server** | ✅ 87 tools, 13 scopes | ❌ | ❌ | ❌ |
| **A2A protocol** | ✅ 5 skills | ❌ | ❌ | ❌ |
| **Memory (FTS5 + vector)** | ✅ | ❌ | ❌ | ❌ |
| **Guardrails (PII, injection, vision)** | ✅ | partial | ❌ | ✅ paid |

2
Provider-Reference.md

@@ -7,7 +7,7 @@
> Regenerate with: `npm run gen:provider-reference`
> **Last generated:** 2026-05-17
Total providers: **177**. See category breakdown below.
Total providers: **226**. See category breakdown below.
## Categories

10
Repository-Map.md

@@ -197,9 +197,9 @@ src/
| Module | Purpose |
| -------------------------------- | ---------------------------------------------------------------------- |
| `constants/providers.ts` | **177 providers** with Zod validation (source of truth) |
| `constants/providers.ts` | **226 providers** with Zod validation (source of truth) |
| `constants/cliTools.ts` | External CLI tool registry |
| `constants/routingStrategies.ts` | **14 routing strategies** with priorities |
| `constants/routingStrategies.ts` | **15 routing strategies** with priorities |
| `constants/publicApiRoutes.ts` | Routes that require Bearer (vs management) auth |
| `constants/upstreamHeaders.ts` | Header denylist for upstream requests |
| `validation/schemas.ts` | ~80 Zod schemas (single source of truth for API contracts) |
@@ -223,7 +223,7 @@ open-sse/
├── translator/ # Format converters (9 request, 8 response, 9 helpers)
├── transformer/ # Responses API ↔ Chat Completions (TransformStream)
├── services/ # ~80+ service modules (combo, accountFallback, autoCombo, reasoningCache, claude code/chatgpt stealth, modelDeprecation, taskAwareRouter, workflowFSM, etc.)
├── mcp-server/ # MCP server (37 tools, 3 transports, ~13 scopes)
├── mcp-server/ # MCP server (87 tools, 3 transports, ~13 scopes)
├── config/ # Provider/model registries, header config, model aliases
├── utils/ # TLS client, proxy fetch/dispatcher, network helpers
├── index.ts # Workspace entry
@@ -354,13 +354,13 @@ open-sse/
| `CLI-TOOLS.md` | External CLI integrations + Internal OmniRoute CLI |
| `I18N.md` | i18n architecture, adding a language, 30 locales |
| `UNINSTALL.md` | Clean uninstall steps |
| `PROVIDER_REFERENCE.md` | **Auto-generated** catalog of 177 providers (regen: `npm run gen:provider-reference`) |
| `PROVIDER_REFERENCE.md` | **Auto-generated** catalog of 226 providers (regen: `npm run gen:provider-reference`) |
### Subsystem deep-dives
| Doc | Purpose |
| -------------------------- | ------------------------------------------------------------------- |
| `MCP-SERVER.md` | MCP server: 37 tools, 3 transports, ~13 scopes, REST endpoints |
| `MCP-SERVER.md` | MCP server: 87 tools, 3 transports, ~13 scopes, REST endpoints |
| `A2A-SERVER.md` | A2A v0.3: JSON-RPC, 5 skills, REST helpers, agent card |
| `AGENT_PROTOCOLS_GUIDE.md` | Unified guide: A2A vs ACP vs Cloud Agents |
| `CLOUD_AGENT.md` | Codex Cloud / Devin / Jules orchestration |

2
Resilience-Guide.md

@@ -114,7 +114,7 @@ Lists active lockouts with: provider, connection, model, reason, expiresAt. Oper
## Other Resilience Features
- **14 routing strategies** (priority, weighted, round-robin, context-relay, fill-first, p2c, random, least-used, cost-optimized, reset-aware, strict-random, auto, lkgp, context-optimized) — see [AUTO-COMBO.md](../routing/AUTO-COMBO.md).
- **15 routing strategies** (priority, weighted, round-robin, context-relay, fill-first, p2c, random, least-used, cost-optimized, reset-aware, strict-random, auto, lkgp, context-optimized) — see [AUTO-COMBO.md](../routing/AUTO-COMBO.md).
- **Reset-aware routing** (v3.8.0) — prioritizes connections by quota reset time.
- **Background mode degradation** — Responses API `background: true` degraded to sync with warning.
- **Dynamic tool limit detection** — backs off providers when tool count limits hit.

2
Setup-Guide.md

@@ -204,7 +204,7 @@ Add to your MCP settings:
}
```
**Full MCP documentation:** [MCP Server README](../../open-sse/mcp-server/README.md) — 37 tools, IDE configs, Python/TS/Go clients.
**Full MCP documentation:** [MCP Server README](../../open-sse/mcp-server/README.md) — 87 tools, IDE configs, Python/TS/Go clients.
### A2A Setup (Agent-to-Agent Protocol)