Files
OmniRoute/docs/guides/VSCODE-COPILOT.md
Diego Rodrigues de Sa e Souza 8ba25e9318 docs: add the VS Code Copilot Chat guide and document the /v1/models prefix modes (#10648)
Adds docs/guides/VSCODE-COPILOT.md covering the OmniCopilot extension: install
from either store, connection setup, what the picker actually shows and why,
the dashboard-in-a-tab mode, and a troubleshooting table.

Documents two contracts that existed in code but nowhere in the docs:

- The ?prefix= query parameter on GET /v1/models, with the warning that
  "canonical" omits providers whose alias already is the canonical id — so
  "alias" is the safe direction for a de-duplicated list.
- MODELS_CATALOG_PREFIX_MODE in .env.example and ENVIRONMENT.md, matching how
  ARENA_ELO_SYNC_ENABLED and PII_REDACTION_ENABLED are already documented.

The fabricated-docs gate cannot see this flag being read, because
resolveFeatureFlag() indexes process.env by key rather than naming it; added
an allowlist entry explaining that, in the style of the existing entries.

Co-authored-by: Xiangzhe <bakryun0718@proton.me>
2026-08-18 05:51:58 -03:00

6.6 KiB

title, version, lastUpdated
title version lastUpdated
VS Code Copilot Chat — OmniCopilot extension 3.8.50 2026-08-18

VS Code Copilot Chat — OmniCopilot extension

OmniCopilot puts every model your OmniRoute serves into the native GitHub Copilot Chat model picker. No second sidebar, no separate chat UI — Copilot's agent mode, tool calling, MCP servers and custom instructions all keep working, just running on the model you pick.

Install (VS Code) Marketplace → diegosouzapw.omnicopilot
Install (forks) Open VSX — Cursor, Windsurf, VSCodium, Theia, code-server, Gitpod, Antigravity, Kiro
Source / issues github.com/diegosouzapw/OmniCopilot (MIT)
Requires VS Code 1.104+

No Copilot subscription needed. Since VS Code 1.122 a language-model provider works without a GitHub sign-in and without any Copilot plan. Inline completions and embeddings-based features stay outside the provider API and still require Copilot.


Setup

  1. Run OmniRoutenpm install -g omniroute && omniroute (dashboard on http://localhost:20128).
  2. Install the extension — search "OmniRoute" in the Extensions view.
  3. Pick a model — Copilot Chat → model picker → Manage Models…OmniRoute, then tick what you want.

Nothing to configure when OmniRoute runs on the default port. For a remote instance, open the OmniRoute icon in the Activity Bar (or run OmniRoute: Manage Connection) and set:

  • Server URL — the server root, e.g. http://192.168.0.15:20128. The /v1 suffix is appended by the extension; do not include it.
  • API key — only when the server sets REQUIRE_API_KEY. Stored in the OS keychain via VS Code SecretStorage, never in settings.json.

What the picker will show

The extension does not show the raw GET /v1/models payload — it shapes it, and the count you see is lower than the catalog size for two deliberate reasons.

It asks for one id per model

MODELS_CATALOG_PREFIX_MODE defaults to dual, which advertises every model twice — once under the short alias prefix and once under the canonical provider prefix — so older client configs keep resolving either form:

cc/claude-sonnet-4-6        ← alias prefix
claude/claude-sonnet-4-6    ← canonical prefix, same model

The extension requests GET /v1/models?prefix=alias so one id arrives per model, without changing the server-wide setting for your other clients. On a reference instance this collapsed 2345 entries to 1396 — 949 duplicates, zero models lost.

If you would rather fix it server-wide for every client, set the MODELS_CATALOG_PREFIX_MODE feature flag to alias in the dashboard. See API_REFERENCE → prefix for the query parameter and the warning about canonical.

It hides models that cannot chat

The catalog also lists image, video, audio, rerank, embedding and moderation models. Those are rejected on a chat request anyway:

HTTP 400 — Model '<id>' is an image-generation model and cannot be used on
/v1/chat/completions. Use POST /v1/images/generations instead.

so they are filtered out by their type field before reaching the picker. Responses-API models are kept — every Codex / GPT-5.x entry advertises supported_endpoints: ["responses"], and OmniRoute translates those for /v1/chat/completions, so they are perfectly usable.

Providers you never configured

The catalog lists models from providers with an active connection plus every noAuth provider — the keyless ones that make up much of the free tier. That is intentional. To hide them, add them to blockedProviders in the dashboard settings; nothing changes in the extension.


Dashboard inside a VS Code tab

omnicopilot.dashboardOpen: "editor" renders the OmniRoute dashboard in an editor tab via the Simple Browser instead of an external browser. Embedding is opt-in on the server: start OmniRoute with

DASHBOARD_ALLOW_EMBED=vscode omniroute

which serves the HTML pages with frame-ancestors 'self' vscode-webview: instead of the default frame-ancestors 'none' + X-Frame-Options: DENY. The API surface (/api, /v1, /v1beta, /a2a, /healthz) keeps the strict headers either way. Without the variable the page refuses to frame and the extension falls back to the external browser — nothing breaks. See ENVIRONMENT.md and issue #10273.


Configuring your other tools from inside VS Code

OmniRoute: Configure Coding CLI drives the omniroute CLI to write ready-to-use profiles for Codex CLI, Claude Code, Cline, Continue, Cursor, Aider, OpenCode, Goose, Crush, Qwen Code, Kilo and Roo — the same configs described in CLI-INTEGRATIONS.md. The API key is handed to the CLI through the OMNIROUTE_API_KEY environment variable, never on the command line.


Troubleshooting

Symptom Cause / fix
No OmniRoute models in the picker Server unreachable. The status-bar dot goes grey; run OmniRoute: Check Connection. Discovery is silent by design and contributes no models rather than prompting.
Every model appears twice You are on an OmniCopilot older than 1.0.1 — update. The extension now requests ?prefix=alias.
An image/audio model used to be listed and is gone Intentional since 1.0.1 — it could never answer a chat request.
Panel missing from the Activity Bar VS Code moves extra view containers into the "…" overflow at the bottom of the Activity Bar, and a container hidden via right-click stays hidden. Right-click the Activity Bar → tick OmniRoute, or open it with OmniRoute: Manage Connection.
Dashboard opens in the browser despite editor mode The server is not started with DASHBOARD_ALLOW_EMBED=vscode (see above). The fallback is deliberate.
Models list is stale after changing providers OmniRoute: Refresh Models, or the ↻ link in the panel.

See also