pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-12 02:02:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: synchronize provider and free-tier inventories

Browse Source
This commit is contained in:
diegosouzapw
2026-08-02 14:45:51 -03:00
parent 2b9ce9b2cd
commit b3005cc368
410 changed files with 12130 additions and 11708 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/frameworks/A2A-SERVER.md
View File

@@ -148,9 +148,9 @@ OmniRoute exposes 6 A2A skills wired in `src/lib/a2a/taskExecution.ts::A2A_SKILL
| Provider Discovery | `provider-discovery` | Lists installed providers with capabilities, free-tier flags, OAuth status | providers, discovery | "What providers are available?" |
| Cost Analysis | `cost-analysis` | Estimates cost of a request/conversation given the catalog + recent usage | cost, usage | "Estimate cost for this conversation" |
| Health Report | `health-report` | Aggregates circuit breaker, cooldown, lockout state per provider | health, resilience | "Show health status of all providers" |
| List Capabilities | `list-capabilities` | Returns the full 42-entry Agent Skills catalog as a markdown table with raw SKILL.md URLs for context injection | catalog, discovery, skills | "List all OmniRoute capabilities" |
| List Capabilities | `list-capabilities` | Returns the full 45-entry Agent Skills catalog (23 API + 21 CLI + 1 config) as a markdown table with raw SKILL.md URLs for context injection | catalog, discovery, skills | "List all OmniRoute capabilities" |
> Note: the Agent Card description currently advertises "36+ providers" (`src/app/.well-known/agent.json/route.ts:26` and `:55`). The actual catalog has grown to 180+ providers — the string should be updated in a follow-up change (tracked as a separate doc/code TODO; not modified here).
> The Agent Card should be kept aligned with the live 327-provider catalog; provider counts and free/no-auth metadata are sourced from the runtime registry.
### `list-capabilities` Skill Detail

2
docs/frameworks/ACP.md
View File

@@ -543,7 +543,7 @@ const agents = detectInstalledAgents();
## What's Next?
- **[API Reference](../reference/API_REFERENCE.md)** — REST API endpoints
- **[Provider Reference](../reference/PROVIDER_REFERENCE.md)** — All 226 providers
- **[Provider Reference](../reference/PROVIDER_REFERENCE.md)** — All 327 providers
- **[MCP Server](./MCP-SERVER.md)** — Model Context Protocol integration
- **[A2A Server](./A2A-SERVER.md)** — Agent-to-Agent protocol
- **[Cloud Agent](./CLOUD_AGENT.md)** — Cloud-based agents

44
docs/frameworks/AGENT-SKILLS.md
View File

@@ -1,13 +1,13 @@
---
title: "OmniRoute Agent Skills Catalog"
version: 3.8.40
lastUpdated: 2026-06-28
version: 3.8.50
lastUpdated: 2026-08-02
---
# OmniRoute Agent Skills Catalog
> **Source of truth:** `src/lib/agentSkills/` (catalog, generator, parsers) + `skills/` directory (SKILL.md files)
> **Last updated:** 2026-06-28 — v3.8.40
> **Last updated:** 2026-08-02 — v3.8.50
Agent Skills are structured SKILL.md files that teach external agents, MCP clients, and A2A orchestrators how to use OmniRoute's REST API and CLI. Unlike [Omni Skills](./SKILLS.md) (which are LLM tool definitions executed inside OmniRoute), Agent Skills are a _documentation catalog_ — static markdown that can be fed directly into agent context.
@@ -15,7 +15,7 @@ Agent Skills are structured SKILL.md files that teach external agents, MCP clien
## Overview
The catalog contains **42 canonical Agent Skills** (22 REST API + 20 CLI). Each skill has:
The catalog contains **45 Agent Skills** (23 REST API + 21 CLI + 1 configuration workflow). Each skill has:
- A **canonical ID** (`omni-auth`, `cli-serve`, etc.)
- A **SKILL.md** file in `skills/{id}/SKILL.md` with YAML frontmatter (`name`, `description`) + rich markdown body
@@ -27,7 +27,7 @@ The catalog contains **42 canonical Agent Skills** (22 REST API + 20 CLI). Each
## Architecture
```
src/shared/constants/agentSkills.ts — 42-entry curated list (name/desc/category/area/icon)
src/shared/constants/agentSkills.ts — 45-entry curated list (name/desc/category/area/icon)
src/lib/agentSkills/
catalog.ts — getCatalog(), getSkillById(), filterCatalog(), computeCoverage()
generator.ts — generateAgentSkills() writes SKILL.md to skills/{id}/
@@ -36,7 +36,7 @@ src/lib/agentSkills/
schemas.ts — Zod schemas: AgentSkillSchema, SkillCoverageSchema, etc.
types.ts — TypeScript interfaces: AgentSkill, SkillCoverage, etc.
skills/{id}/SKILL.md — Generated + curated markdown files (42 total)
skills/{id}/SKILL.md — Generated + curated markdown files (45 total)
src/app/api/agent-skills/
route.ts — GET /api/agent-skills
@@ -92,7 +92,7 @@ The generator preserves content between `<!-- skill:custom-start -->` and `<!--
| Endpoint | Method | Description | Auth |
| :--------------------------- | :----- | :------------------------------------------------------- | :--------- |
| `/api/agent-skills` | GET | List catalog (optional `?category=api\|cli&area=<area>`) | none |
| `/api/agent-skills` | GET | List catalog (optional `?category=api\|cli\|config&area=<area>`) | none |
| `/api/agent-skills/{id}` | GET | Get single skill metadata | none |
| `/api/agent-skills/{id}/raw` | GET | Fetch SKILL.md as `text/markdown` | none |
| `/api/agent-skills/coverage` | GET | Coverage stats (how many SKILL.md files exist) | none |
@@ -128,7 +128,7 @@ See [MCP-SERVER.md](./MCP-SERVER.md) for scope wiring and authentication.
## A2A Discovery
The A2A skill `list-capabilities` returns the full 42-skill catalog as a markdown table artifact. External orchestrators can invoke it via:
The A2A skill `list-capabilities` returns the full 45-skill catalog as a markdown table artifact. External orchestrators can invoke it via:
```json
{
@@ -146,9 +146,9 @@ See [A2A-SERVER.md](./A2A-SERVER.md) for protocol details.
---
## Catalog — 42 Skill IDs
## Catalog — 45 Skill IDs
### API Skills (22)
### API Skills (23)
| ID | Area | Entry Point |
| :--------------------- | :-------------- | :---------------------------------- |
@@ -170,12 +170,12 @@ See [A2A-SERVER.md](./A2A-SERVER.md) for protocol details.
| `omni-sync-cloud` | sync-cloud | Cloud sync |
| `omni-db-backups` | db-backups | Database backups |
| `omni-webhooks` | webhooks | Webhook event dispatcher |
| `omni-mcp` | mcp | MCP server (87 tools, 3 transports) |
| `omni-mcp` | mcp | MCP server (107 tools, 3 transports) |
| `omni-agents-a2a` | agents-a2a | A2A agent protocol |
| `omni-version-manager` | version-manager | Version and update management |
| `omni-inference` | inference | Direct inference / completions |
### CLI Skills (20)
### CLI Skills (21)
| ID | Area | CLI Command Root |
| :------------------- | :----------------- | :---------------------- |
@@ -199,6 +199,13 @@ See [A2A-SERVER.md](./A2A-SERVER.md) for protocol details.
| `cli-eval` | cli-eval | `omniroute eval` |
| `cli-plugins-skills` | cli-plugins-skills | `omniroute plugins` |
| `cli-setup` | cli-setup | `omniroute setup` |
| `cli-skill-collector` | cli-setup | `omniroute skills` |
### Configuration workflow (1)
| ID | Area | Entry Point |
| :---------------- | :--------------- | :------------------------------- |
| `config-codex-cli` | config-codex-cli | Codex CLI configuration workflow |
---
@@ -233,7 +240,7 @@ resp = requests.post("http://your-omniroute/a2a", json={
"params": {"skill": "list-capabilities", "messages": [{"role": "user", "content": "list"}]}
})
table = resp.json()["result"]["artifacts"][0]["content"]
# table is a markdown table with all 42 skill IDs + rawUrl columns
# table is a markdown table with all 45 skill IDs + rawUrl columns
```
### 4. Direct GitHub raw fetch (no server required)
@@ -291,10 +298,11 @@ curl "http://localhost:20128/api/agent-skills/coverage"
```json
{
"api": { "have": 22, "total": 22 },
"cli": { "have": 20, "total": 20 },
"totalSkills": 42,
"generatedAt": "2026-05-28T00:00:00.000Z"
"api": { "have": 23, "total": 23 },
"cli": { "have": 21, "total": 21 },
"config": { "have": 1, "total": 1 },
"totalSkills": 45,
"generatedAt": "2026-08-02T00:00:00.000Z"
}
```
@@ -306,4 +314,4 @@ curl "http://localhost:20128/api/agent-skills/coverage"
- [MCP-SERVER.md](./MCP-SERVER.md) — MCP tool catalog (`omniroute_agent_skills_*` tools)
- [A2A-SERVER.md](./A2A-SERVER.md) — A2A protocol (`list-capabilities` skill)
- `src/lib/agentSkills/` — catalog, generator, parsers
- `skills/` — generated SKILL.md files (42 entries)
- `skills/` — generated SKILL.md files (45 entries)

2
docs/frameworks/AGENTBRIDGE.md
View File

@@ -22,7 +22,7 @@ When an IDE agent (e.g., GitHub Copilot, Cursor, Claude Code) makes an API call,
This means you can:
- **Reroute any agent to any provider**: Copilot talking to OpenAI? Redirect it to Anthropic Claude, Gemini, or any of OmniRoute's 226+ providers.
- **Reroute any agent to any provider**: Copilot talking to OpenAI? Redirect it to Anthropic Claude, Gemini, or any of OmniRoute's 327 providers.
- **Apply model mappings**: `gemini-3-flash` → `claude-sonnet-4.7` transparently at the handler level.
- **Observe all agent traffic**: every intercepted request is published to the [Traffic Inspector](./TRAFFIC_INSPECTOR.md).
- **Apply OmniRoute resilience**: combo routing, circuit breakers, fallbacks, and cost tracking work for IDE agent traffic too.

4
docs/frameworks/AGENT_PROTOCOLS_GUIDE.md
View File

@@ -24,7 +24,7 @@ The three are independent — pick any subset.
## Decision Tree
```
Do you need a cloud service to do work outside this machine (Codex Cloud / Devin / Jules)?
Do you need a cloud service to do work outside this machine (Codex Cloud / Cursor Cloud / Devin / Jules)?
├─ YES → Cloud Agents (POST /api/v1/agents/tasks)
└─ NO → Continue
│
@@ -183,7 +183,7 @@ Both have "long-running tasks" but at different layers:
curl http://localhost:20128/.well-known/agent.json
```
Returns the Agent Card with all 5 skills, transports, and version.
Returns the Agent Card with all 6 skills, transports, and version.
### Call OmniRoute as an A2A agent

18
docs/frameworks/OPEN_SSE_ARCHITECTURE.md
View File

@@ -105,7 +105,7 @@ Resolves the request to a concrete `(provider, model, account, credentials)` tup
For `auto/*` models, this stage also:
- Runs the **9-factor scoring** algorithm (`services/autoCombo/`)
- Runs the **13-factor scoring** algorithm (`services/autoCombo/`)
- Selects a `provider+model` pair based on health, cost, latency, etc.
### Stage 2: Translate (translator/)
@@ -228,7 +228,7 @@ export async function handleComboChat(body, comboId): Promise<ChatResult> {
}
```
Supports **17 routing strategies** (see `src/shared/constants/routingStrategies.ts`):
Supports **19 routing strategies** (see `src/shared/constants/routingStrategies.ts`):
| Strategy | Behavior |
| ------------------- | ------------------------------------------------------------------------- |
@@ -245,7 +245,7 @@ Supports **17 routing strategies** (see `src/shared/constants/routingStrategies.
| `reset-window` | Reset window-based routing |
| `headroom` | Most remaining quota headroom first |
| `strict-random` | Truly uniform (no quality weighting) |
| `auto` | Use 9-factor scoring (`autoCombo/`) |
| `auto` | Use 13-factor scoring (`autoCombo/`) |
| `lkgp` | Last known good provider first |
| `context-optimized` | Best for long-context requests |
| `fusion` | Fan out to a panel in parallel, then synthesize via a judge (`fusion.ts`) |
@@ -280,7 +280,7 @@ Services are **focused, single-purpose modules** that handlers compose. The big
### Routing & Combo
- `combo.ts` — entry point for combo-routed requests
- `services/autoCombo/` — 9-factor scoring, 8 auto routing strategies
- `services/autoCombo/` — 13-factor scoring, 8 auto routing strategies
- `wildcardRouter.ts` — matches wildcard routes (`gpt-*`)
- `modelFamilyFallback.ts` — T5 intra-family fallback
@@ -368,7 +368,7 @@ const result = await executor.execute({
});
````
The factory is generated from `config/providerRegistry.ts` which lists all 212+ providers and their executor class.
The factory covers all **327 provider catalog entries** through shared defaults and **89 executor implementation modules**. Most OpenAI-compatible providers use `DefaultExecutor`; specialized modules override only the behavior that differs.
---
@@ -406,9 +406,9 @@ Common translations:
`open-sse/mcp-server/` implements the **Model Context Protocol** server:
- **30+ tools** (provider management, combos, memory, cache, compression, 1proxy, skills)
- **107 deduplicated tools** (provider management, combos, memory, cache, compression, 1proxy, skills)
- **3 transports**: stdio, SSE, Streamable HTTP
- **13 scopes** for fine-grained authorization
- **32 scopes** for fine-grained authorization
### Tool Registration
@@ -487,7 +487,7 @@ This handles:
| File | Purpose |
| ----------------------------- | --------------------------------- |
| `providerRegistry.ts` | 212+ provider definitions |
| `providerRegistry.ts` | 327 provider catalog entries |
| `providerModels.ts` | Model aliases, format mapping |
| `constants.ts` | Timeouts, limits, status codes |
| `defaultThinkingSignature.ts` | Default Claude thinking signature |
@@ -570,7 +570,7 @@ The routing engine has strict performance budgets:
- [ARCHITECTURE.md](../architecture/ARCHITECTURE.md) — high-level architecture
- [CODEBASE_DOCUMENTATION.md](../architecture/CODEBASE_DOCUMENTATION.md) — engineering reference
- [REPOSITORY_MAP.md](../architecture/REPOSITORY_MAP.md) — directory-by-directory
- [AUTO-COMBO.md](../routing/AUTO-COMBO.md) — 9-factor scoring
- [AUTO-COMBO.md](../routing/AUTO-COMBO.md) — 13-factor scoring
- [MCP-SERVER.md](./MCP-SERVER.md) — MCP server
- [A2A-SERVER.md](./A2A-SERVER.md) — A2A server
- Source: `open-sse/` (400+ files, ~143K LOC)

2
docs/frameworks/SKILLS.md
View File

@@ -25,7 +25,7 @@ OmniRoute has two distinct but complementary skill systems:
| Source of truth | `src/lib/skills/` + marketplace | `src/lib/agentSkills/` + `skills/` directory |
| Runtime mode | Injected into outbound requests, executed on tool-call events | Static markdown catalog + REST/MCP/A2A discovery endpoints |
| Who uses it | OmniRoute itself (combo routing, inbound LLM calls) | External agents, MCP clients, A2A orchestrators |
| Count | Variable (marketplace-driven) | 42 canonical entries (22 API + 20 CLI) |
| Count | Variable (marketplace-driven) | 45 catalog entries (23 API + 21 CLI + 1 config) |
| Format | `SkillDefinition` with tool schema + handler | `SKILL.md` frontmatter + markdown body |
| Discovery | `/api/skills/*` REST + `omniroute_skills_*` MCP tools | `/api/agent-skills/*` REST + `omniroute_agent_skills_*` MCP tools + A2A `list-capabilities` |