mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-19 13:42:09 +03:00
docs(mcp): complete MCP server README tool reference (#10039)
The MCP server README covered only 29 of the 43 schema entries, listing the remaining tools solely as a gap note with omniroute_tool_search as the runtime fallback. Add tool-reference tables for the agent-skills trio, oneproxy trio, web_fetch/web_search, tool_search, create_combo, set_routing_strategy, pick_fastest_model, sync_pricing, and db_health_check so the README covers the full schemas catalog, and fold the coverage note into the tool_search discovery paragraph.
This commit is contained in:
Brandon Bennett
@@ -1 +1,2 @@
|
||||
- **feat(admission):** add lane-aware admission probes for combo/fusion/chaos fan-out (fail-open, queueing disabled), an env-wins `OMNIROUTE_CHAT_VIRTUAL_LANES` activation flag applied at boot, and adaptive-lane visibility in the `omniroute_get_health` MCP tool (related to #9654)
|
||||
- **docs(mcp):** complete the MCP server README tool reference so the `schemas/` catalog is fully covered (agent-skills, oneproxy, web, tool-search, combo/routing, pricing and DB-health tools were previously only discoverable via `omniroute_tool_search`)
|
||||
|
||||
@@ -173,6 +173,40 @@ compression is enabled. `omniroute_compression_status` exposes those savings sep
|
||||
`analytics.mcpDescriptionCompression` with `source: "mcp_metadata_estimate"`, so clients do not
|
||||
mistake metadata shrink estimates for provider token receipts.
|
||||
|
||||
### Discovery & Web Tools
|
||||
|
||||
| Tool | Scopes | Description |
|
||||
| ----------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `omniroute_tool_search` | `read:tools` | Keyword search across the registered MCP tools; returns compact one-line signatures for token-efficient discovery |
|
||||
| `omniroute_web_fetch` | `execute:search` | Fetch and extract a URL's content through the web-fetch gateway (Firecrawl, Jina Reader, Tavily, TinyFish) with automatic failover |
|
||||
| `omniroute_web_search` | `execute:search` | Web search through the search gateway (Serper, Brave, Perplexity, Exa, Tavily, Google PSE, Linkup, SearchAPI, SearXNG) with failover |
|
||||
|
||||
### Skills & Catalog Tools
|
||||
|
||||
| Tool | Scopes | Description |
|
||||
| --------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `omniroute_agent_skills_list` | `read:catalog` | List all 42 agent skills with optional `category` (`api`\|`cli`) and `area` filters; metadata + coverage |
|
||||
| `omniroute_agent_skills_get` | `read:catalog` | Full metadata + SKILL.md content for a single skill by canonical `id` |
|
||||
| `omniroute_agent_skills_coverage` | `read:catalog` | Coverage stats: how many of the 22 API and 20 CLI skills have SKILL.md files on disk vs catalog totals |
|
||||
|
||||
### Proxy, Pricing & Data Tools
|
||||
|
||||
| Tool | Scopes | Description |
|
||||
| --------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `omniroute_oneproxy_fetch` | `read:proxies` | Fetch free proxies from the 1proxy marketplace (protocol/country/quality/limit filters) |
|
||||
| `omniroute_oneproxy_rotate` | `read:proxies` | Get the next available proxy by strategy (`random` / `quality` / `sequential`) |
|
||||
| `omniroute_oneproxy_stats` | `read:proxies` | Pool stats, sync status, distribution by protocol and country |
|
||||
| `omniroute_sync_pricing` | `pricing:write` | Sync pricing from external sources (LiteLLM) without overwriting user-set prices; `dryRun` |
|
||||
| `omniroute_db_health_check` | `read:health`, `write:resilience` | Diagnose (and optionally auto-repair) database drift — broken combo refs, orphan rows |
|
||||
|
||||
### Combo & Routing Tools
|
||||
|
||||
| Tool | Scopes | Description |
|
||||
| -------------------------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------- |
|
||||
| `omniroute_create_combo` | `write:combos` | Register a new combo (model chain) with name, ordered model list, and optional strategy |
|
||||
| `omniroute_set_routing_strategy` | `write:combos` | Update combo routing strategy at runtime (`priority` / `weighted` / `auto` / etc.) |
|
||||
| `omniroute_pick_fastest_model` | `read:combos`, `read:health`, `read:usage` | Pick the fastest reliable provider-model pair from live telemetry; can apply latency routing |
|
||||
|
||||
---
|
||||
|
||||
### Adaptive Admission Lane Data
|
||||
@@ -199,18 +233,13 @@ entirely when the health endpoint reports no adaptive-admission data.
|
||||
|
||||
### Skills & Tool Navigability
|
||||
|
||||
The catalog rows above are a curated summary, not the full surface: they cover 29 of the 43 schema
|
||||
entries in `schemas/` (audit snapshot — expect drift as the catalog grows), and the authoritative
|
||||
full catalog lives in
|
||||
[`docs/frameworks/MCP-SERVER.md`](../../docs/frameworks/MCP-SERVER.md). The schema entries without a
|
||||
README row are the agent-skills group (`agent_skills_coverage` / `agent_skills_get` /
|
||||
`agent_skills_list`), the oneproxy group (`oneproxy_fetch` / `oneproxy_rotate` / `oneproxy_stats`),
|
||||
`web_fetch` / `web_search`, `tool_search`, `create_combo`, `set_routing_strategy`,
|
||||
`pick_fastest_model`, `sync_pricing`, and `db_health_check`.
|
||||
The tables above cover the full `schemas/` catalog (43 entries); the authoritative reference with
|
||||
scope-enforcement and transport details lives in
|
||||
[`docs/frameworks/MCP-SERVER.md`](../../docs/frameworks/MCP-SERVER.md).
|
||||
|
||||
Agents never need the README to find these: `omniroute_tool_search` performs keyword search
|
||||
across the registered tool set and returns compact signatures (token-efficient discovery), so
|
||||
undiscovered capabilities stay discoverable at runtime.
|
||||
Agents never need to read this file to find a capability: `omniroute_tool_search` performs keyword
|
||||
search across the registered tool set and returns compact one-line signatures (token-efficient
|
||||
discovery), so newly added capabilities stay discoverable at runtime.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user