[leninejunior]

Summary

Adds docs/AGENTROUTER.md, a focused setup guide for connecting AgentRouter (the relay promoted in the README's affiliate banner) to OmniRoute.

AgentRouter only accepts traffic that matches the Claude Code wire image, so the existing openai-compatible-chat provider type does not work against it. OmniRoute already ships the right bridge — the anthropic-compatible-cc-* provider type in open-sse/services/claudeCodeCompatible.ts — but it sits behind the ENABLE_CC_COMPATIBLE_PROVIDER=true feature flag and there is currently no documentation pointing users to it. The new doc covers:

• Why a generic OpenAI-compatible provider fails (upstream WAF + client whitelist)
• How to enable the ENABLE_CC_COMPATIBLE_PROVIDER feature flag (env var + Docker example)
• Step-by-step dashboard setup (Add Claude Code Compatible → fields → connection)
• The exact wire image OmniRoute sends (for reference)
• Troubleshooting for the specific upstream error shapes (unauthorized_client_detected, 无效的令牌, content-blocked)

Test plan

• npm run check:any-budget:t11 — passes (no code changes; docs-only PR)
• Pre-commit hook (lint-staged, check-docs-sync, env/i18n sync) — passes
• Markdown rendering verified on GitHub preview
• All internal links resolve (./PROVIDERS.md, ./reference/FREE_TIERS.md, ../open-sse/services/claudeCodeCompatible.ts, ../README.md)
• End-to-end verified locally: ran a deployment with ENABLE_CC_COMPATIBLE_PROVIDER=true, followed the steps in the doc, and confirmed a working chat completion against agentrouter.org via the anthropic-compatible-cc-* provider type.

[gemini-code-assist]

Code Review

This pull request introduces a new setup guide for AgentRouter in docs/AGENTROUTER.md, detailing the configuration of the Claude Code compatible provider. The review feedback identifies a consistency issue in a usage example where a custom prefix should be used instead of an internal one, and points out a typo in an error code within the troubleshooting section.

[gemini-code-assist]

The example model ID uses the internal provider prefix anthropic-compatible-cc- instead of the custom prefix agentrouter suggested in the setup table (Step 2). Using the custom prefix in the example makes the guide more consistent and easier for users to follow after they have just configured that prefix.

Suggested change

	"model": "anthropic-compatible-cc-<your-node-id>/claude-opus-4-6",
	"model": "agentrouter/claude-opus-4-6",

[gemini-code-assist]

The error code unauthorized_client_error appears to be a typo. Based on the PR description and the previous troubleshooting entry (line 109), it should likely be unauthorized_client_detected to match the specific upstream error shape mentioned.

Suggested change

	`unauthorized_client_error` even though the key is valid. Check which models your
	`unauthorized_client_detected` even though the key is valid. Check which models your

[kilo-code-bot]

SUGGESTION: Inconsistent placeholder terminology — the table above (line 46) refers to "Prefix" with value agentrouter, but the curl example uses <your-node-id>. Change to <your-prefix> for consistency and clarity, so users understand the model ID uses the same prefix value they set in the dashboard.

[kilo-code-bot]

SUGGESTION: The provider type pattern is anthropic-compatible-cc-* (with a trailing node ID). Consider updating to "provider type starts with anthropic-compatible-cc" or "provider type is anthropic-compatible-cc-*" to avoid implying a literal exact match.

[kilo-code-bot]

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Incremental Review Notes

The changes in this incremental commit address all previously raised suggestions:

• Previously flagged line 63: Placeholder terminology <your-node-id> has been replaced with consistent Prefix terminology throughout the documentation.
• Previously flagged line 128: Provider type reference has been clarified to anthropic-compatible-cc- (with trailing dash) and correctly points to CLAUDE_CODE_COMPATIBLE_PREFIX constant.

Changes Reviewed

All modifications in docs/AGENTROUTER.md are documentation-only updates that improve clarity:

1. Table field descriptions (lines 54-59): Enhanced Prefix field description to "friendly alias shown in logs and the dashboard"
2. Canonical ID clarification (lines 61-63): Added note explaining relationship between canonical model identifier and Prefix alias
3. Example update (line 80): Changed example from full provider ID to user-friendly agentrouter/claude-opus-4-6 format
4. Canonical ID note (lines 86-87): Added clarification that canonical ID also works and appears in database/combo config
5. Troubleshooting fix (lines 137-138): Correctly specifies trailing dash in anthropic-compatible-cc- pattern and references the actual code constant

All code references verified against open-sse/services/claudeCodeCompatible.ts and src/lib/usage/callLogs.ts. Documentation accurately reflects implementation.

Files Reviewed (1 file)

• docs/AGENTROUTER.md - Documentation improvements, no issues found

---

_{Reviewed by qwen3.6-plus · 244,933 tokens}

[leninejunior]

Thanks for the review! Applied 3 of 4 suggestions:

1. Provider ID wildcard (anthropic-compatible-cc → anthropic-compatible-cc-*) — applied in 8337233.

2. Prefix vs. node ID terminology — clarified the table description and added a callout that the Prefix is a friendly alias resolved by src/lib/usage/callLogs.ts, while the canonical ID still uses the UUID-suffixed form.

3. Friendly prefix in the curl example (agentrouter/claude-opus-4-6 instead of anthropic-compatible-cc-<uuid>/...) — applied in 779bbe0, after verifying locally that the omniroute model resolver accepts the user-defined prefix as an alias.

4. Skipping: the suggestion to change unauthorized_client_error → unauthorized_client_detected in the troubleshooting on the "models not in plan" entry. Those are two different fields in the same upstream response:

   {
     "error": { "message": "unauthorized client detected, ..." },
     "type":  "unauthorized_client_error"
   }

   The first troubleshooting entry quotes the message text; the "models not in plan" entry references the type code. Both are accurate as-is.

[diegosouzapw]

Code Review — AgentRouter Provider Analysis

Verified against the current codebase: OmniRoute already ships a native agentrouter provider in open-sse/config/providerRegistry.ts that is correctly wired with the full Claude Code wire image (same headers documented in Section 3):

agentrouter: {
  format: "claude",
  baseUrl: "https://agentrouter.org/v1/messages",
  authHeader: "x-api-key",
  headers: {
    "User-Agent": CLAUDE_CLI_USER_AGENT,       // claude-cli/2.1.137
    "Anthropic-Beta": ANTHROPIC_BETA_CLAUDE_OAUTH,
    "Anthropic-Version": ANTHROPIC_VERSION_HEADER,
    "Anthropic-Dangerous-Direct-Browser-Access": "true",
    "X-App": "cli",
    // + full Stainless SDK headers
  }
}

This native path requires no feature flag — users can go directly to Dashboard → Providers → Add Provider → AgentRouter and paste their API key, without setting ENABLE_CC_COMPATIBLE_PROVIDER=true.

Suggestion: Consider adding a note at the top of the guide mentioning the native provider path as the recommended approach (simpler, no env var), and framing the CC-compatible path as an alternative for users who need more control over the wire image (e.g. custom headers, non-standard base URLs).

Docs content is technically accurate for the CC-compatible path — the troubleshooting section is especially useful. Approving.

[diegosouzapw]

LGTM — docs are accurate for the CC-compatible path. Left a comment suggesting to also mention the simpler native agentrouter provider (no feature flag required). Approving as-is; the additional note can be a follow-up.

[diegosouzapw]

🎉 Thank you @leninejunior for the AgentRouter setup guide! The documentation has been integrated into the v3.8.0 release. Note: we also left a suggestion to optionally mention the native agentrouter provider path (no feature flag required) — feel free to follow up with that enhancement in the next cycle.

[diegosouzapw]

Thank you @leninejunior for this documentation contribution! The AgentRouter setup guide is now part of OmniRoute v3.8.0. The step-by-step instructions covering API key configuration and the wire-image headers will help users connect to AgentRouter.org without having to dig through the code. Appreciated!