@orcarouter/mcp 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/LICENSE +21 -0
  2. package/README.de.md +118 -0
  3. package/README.es.md +126 -0
  4. package/README.fr.md +126 -0
  5. package/README.hi.md +126 -0
  6. package/README.it.md +127 -0
  7. package/README.ja.md +123 -0
  8. package/README.ko.md +118 -0
  9. package/README.md +126 -0
  10. package/README.pt.md +126 -0
  11. package/README.ru.md +126 -0
  12. package/README.vi.md +126 -0
  13. package/README.zh-CN.md +122 -0
  14. package/assets/logo.gif +0 -0
  15. package/dist/index.js +736 -0
  16. package/dist/index.js.map +1 -0
  17. package/package.json +55 -0
package/README.ja.md ADDED
@@ -0,0 +1,123 @@
1
+ <p align="center">
2
+ <a href="https://www.orcarouter.ai">
3
+ <img src="https://raw.githubusercontent.com/Continuum-AI-Corp/orcarouter-mcp-server/main/assets/logo.gif" alt="OrcaRouter" width="180" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">OrcaRouter MCP Server</h1>
8
+
9
+ <p align="center">
10
+ <a href="https://www.orcarouter.ai">OrcaRouter</a> LLM ゲートウェイ公式の MCP サーバーです。
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://discord.com/invite/943Zqp9bs"><img src="https://img.shields.io/discord/1501106943178309662?logo=discord&label=discord&color=5865F2" alt="Discord" /></a>
15
+ <a href="https://x.com/OrcaRouter"><img src="https://img.shields.io/badge/X-Follow-000000?logo=x&logoColor=white" alt="X" /></a>
16
+ <a href="https://www.npmjs.com/package/@orcarouter/mcp"><img src="https://img.shields.io/npm/v/@orcarouter/mcp" alt="npm version" /></a>
17
+ <a href="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml"><img src="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml/badge.svg" alt="CI" /></a>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-CN.md">中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.fr.md">Français</a> | <a href="README.es.md">Español</a> | <a href="README.it.md">Italiano</a> | <a href="README.ru.md">Русский</a> | <a href="README.pt.md">Português</a> | <a href="README.vi.md">Tiếng Việt</a> | <a href="README.hi.md">हिन्दी</a>
22
+ </p>
23
+
24
+ <br/>
25
+
26
+ [OrcaRouter](https://www.orcarouter.ai) のモデルカタログを閲覧し、
27
+ [Model Context Protocol](https://modelcontextprotocol.io) に対応する任意のクライアント
28
+ （Claude Desktop、Claude Code、Cursor、Windsurf、Zed など）からチャット補完を実行できます。
29
+
30
+ カタログの閲覧は **API キー不要** — サインアップ前に料金や機能を比較できます。
31
+
32
+ ## できること
33
+
34
+ - 🗺️ API キーなしでプロバイダーとモデルを発見
35
+ - 💬 配信中の任意のモデルでチャット補完を実行
36
+ - 🧠 ワークスペースの `orcarouter/auto` ルーター経由でリクエストを自動ルーティング（cost / quality / balanced / LinUCB / gated-adaptive 戦略）
37
+ - 🔁 回復性のためのフォールバックチェーン設定（プライマリ + 最大 4 つのフォールバック）
38
+ - 📊 プロバイダー、機能、最小コンテキストウィンドウでモデルをサーバー側フィルタリング
39
+ - 🎯 詳細なモデルカードを確認: 料金、コンテキスト、レイテンシ、対応エンドポイント
40
+ - 🔌 Claude Desktop、Claude Code、Cursor、Windsurf、Zed、その他すべての MCP クライアントで動作
41
+
42
+ ## 使用例
43
+
44
+ 次のように話しかけてみてください:
45
+
46
+ - *「OrcaRouter 上のすべてのプロバイダーを一覧表示して」*
47
+ - *「Anthropic のすべてのモデルを料金付きで見せて」*
48
+ - *「`minimax/minimax-m2.7` の詳細を教えて」*
49
+ - *「`orcarouter/auto` とチャットして、量子コンピューティングについて説明して」*
50
+
51
+ ## クイックスタート
52
+
53
+ ### Claude Code (CLI ワンライナー)
54
+
55
+ ```bash
56
+ claude mcp add orcarouter -s user \
57
+ -e ORCAROUTER_API_KEY=sk-orca-your-key \
58
+ -- npx -y @orcarouter/mcp
59
+ ```
60
+
61
+ ### その他のクライアント (設定ファイル方式)
62
+
63
+ 1. お使いの MCP クライアント用のサンプル設定をクライアントの設定ファイルにコピーします:
64
+
65
+ | Client | Example | Action |
66
+ | --------------- | --------------------------------------------------- | ------- |
67
+ | Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | 置き換え |
68
+ | Claude Code | [claude-code.json](examples/claude-code.json) | マージ |
69
+ | Cursor | [cursor.json](examples/cursor.json) | 置き換え |
70
+ | Windsurf | [windsurf.json](examples/windsurf.json) | 置き換え |
71
+
72
+ 設定ファイルのパスや Zed などその他のクライアントに関する注意点は [`examples/README.md`](examples/README.md) を参照してください。
73
+
74
+ 2. コピーしたファイル内の `sk-or-...` をあなたの [OrcaRouter API key](https://www.orcarouter.ai/console) に置き換えます。
75
+ 3. MCP クライアントを再起動します。
76
+
77
+ Node.js 18 以降が必要です。`ORCAROUTER_API_KEY` 環境変数は
78
+ `orcarouter_chat` でのみ必要で、カタログ系ツールはこれなしで動作します。
79
+
80
+ ## ツール
81
+
82
+ - `orcarouter_chat` — チャット補完を実行（オプションでフォールバックチェーン対応）
83
+ - `orcarouter_models_list` — カタログを閲覧（料金、コンテキスト、機能）
84
+ - `orcarouter_model_card` — 1 つのモデルの詳細情報
85
+ - `orcarouter_providers_list` — プロバイダー一覧とモデル数
86
+
87
+ 入力スキーマの全文は MCP の `tools/list` メソッドを通じて実行時に公開されます — お使いの MCP クライアント（Claude Desktop、Cursor など）が自動で読み込みます。
88
+
89
+ ## 設定
90
+
91
+ | Name | Required | 説明 |
92
+ | --------------------------- | -------- | ---------------------------------------------------------- |
93
+ | `ORCAROUTER_API_KEY` | optional | OrcaRouter API キー。`orcarouter_chat` でのみ必要です。 |
94
+ | `ORCAROUTER_BASE_URL` | optional | API ベース URL。デフォルトは `https://api.orcarouter.ai`。 |
95
+ | `ORCAROUTER_REQUEST_TIMEOUT`| optional | リクエストごとの HTTP タイムアウト（**秒**単位）。デフォルトは `300`。 |
96
+
97
+ ## セキュリティ
98
+
99
+ API キーは環境変数から読み込まれ、ログには記録されず、OrcaRouter API にのみ送信されます。
100
+ 脆弱性開示ポリシーについては [SECURITY.md](SECURITY.md) を参照してください。
101
+
102
+ ## 開発
103
+
104
+ ```sh
105
+ # bun (推奨)
106
+ bun install
107
+ bun run test
108
+ bun run typecheck
109
+ bun run build
110
+
111
+ # または npm を使用
112
+ npm install
113
+ npm test
114
+ npm run typecheck
115
+ npm run build
116
+ ```
117
+
118
+ ビルドにより `dist/index.js` に `#!/usr/bin/env node` shebang 付きの
119
+ ESM バンドルが生成され、`orcarouter-mcp` バイナリとして実行できます。
120
+
121
+ ## ライセンス
122
+
123
+ [MIT](LICENSE)
package/README.ko.md ADDED
@@ -0,0 +1,118 @@
1
+ <p align="center">
2
+ <a href="https://www.orcarouter.ai">
3
+ <img src="https://raw.githubusercontent.com/Continuum-AI-Corp/orcarouter-mcp-server/main/assets/logo.gif" alt="OrcaRouter" width="180" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">OrcaRouter MCP Server</h1>
8
+
9
+ <p align="center">
10
+ <a href="https://www.orcarouter.ai">OrcaRouter</a> LLM 게이트웨이를 위한 공식 MCP 서버입니다.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://discord.com/invite/943Zqp9bs"><img src="https://img.shields.io/discord/1501106943178309662?logo=discord&label=discord&color=5865F2" alt="Discord" /></a>
15
+ <a href="https://x.com/OrcaRouter"><img src="https://img.shields.io/badge/X-Follow-000000?logo=x&logoColor=white" alt="X" /></a>
16
+ <a href="https://www.npmjs.com/package/@orcarouter/mcp"><img src="https://img.shields.io/npm/v/@orcarouter/mcp" alt="npm version" /></a>
17
+ <a href="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml"><img src="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml/badge.svg" alt="CI" /></a>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-CN.md">中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.fr.md">Français</a> | <a href="README.es.md">Español</a> | <a href="README.it.md">Italiano</a> | <a href="README.ru.md">Русский</a> | <a href="README.pt.md">Português</a> | <a href="README.vi.md">Tiếng Việt</a> | <a href="README.hi.md">हिन्दी</a>
22
+ </p>
23
+
24
+ <br/>
25
+
26
+ [OrcaRouter](https://www.orcarouter.ai)의 모델 카탈로그를 둘러보고, 모든 [Model Context Protocol](https://modelcontextprotocol.io) 클라이언트 — Claude Desktop, Claude Code, Cursor, Windsurf, Zed 또는 해당 프로토콜을 지원하는 모든 도구 — 내부에서 채팅 완성을 실행할 수 있습니다.
27
+
28
+ 카탈로그 탐색은 **API 키 없이도** 작동합니다 — 가입 전에 가격과 기능을 비교해 보세요.
29
+
30
+ ## 할 수 있는 일
31
+
32
+ - 🗺️ API 키 없이 프로바이더와 모델을 탐색
33
+ - 💬 제공되는 모든 모델을 통해 채팅 완성을 실행
34
+ - 🧠 워크스페이스의 `orcarouter/auto` 라우터를 통해 요청을 자동 라우팅 (cost / quality / balanced / LinUCB / gated-adaptive 전략)
35
+ - 🔁 복원력을 위한 폴백 체인 구성 (기본 + 최대 4개의 폴백)
36
+ - 📊 프로바이더, 기능 또는 최소 컨텍스트 윈도우로 서버 측에서 모델 필터링
37
+ - 🎯 상세한 모델 카드 확인: 가격, 컨텍스트, 레이턴시, 지원되는 엔드포인트
38
+ - 🔌 Claude Desktop, Claude Code, Cursor, Windsurf, Zed 및 모든 MCP 클라이언트와 호환
39
+
40
+ ## 예시
41
+
42
+ 다음과 같이 말해 보세요:
43
+
44
+ - *"List all providers on OrcaRouter"*
45
+ - *"Show me all Anthropic models with their pricing"*
46
+ - *"Get details about `minimax/minimax-m2.7`"*
47
+ - *"Chat with `orcarouter/auto` and explain quantum computing"*
48
+
49
+ ## 빠른 시작
50
+
51
+ ### Claude Code (CLI 한 줄 명령)
52
+
53
+ ```bash
54
+ claude mcp add orcarouter -s user \
55
+ -e ORCAROUTER_API_KEY=sk-orca-your-key \
56
+ -- npx -y @orcarouter/mcp
57
+ ```
58
+
59
+ ### 다른 클라이언트 (설정 파일 경로)
60
+
61
+ 1. 사용하는 MCP 클라이언트의 예제 설정을 해당 클라이언트의 설정 파일에 복사합니다:
62
+
63
+ | Client | Example | Action |
64
+ | --------------- | --------------------------------------------------- | ------- |
65
+ | Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | 교체 |
66
+ | Claude Code | [claude-code.json](examples/claude-code.json) | 병합 |
67
+ | Cursor | [cursor.json](examples/cursor.json) | 교체 |
68
+ | Windsurf | [windsurf.json](examples/windsurf.json) | 교체 |
69
+
70
+ 설정 파일 경로와 Zed 및 기타 클라이언트에 대한 참고 사항은 [`examples/README.md`](examples/README.md)를 참조하세요.
71
+
72
+ 2. 복사한 파일에서 `sk-or-...`를 본인의 [OrcaRouter API key](https://www.orcarouter.ai/console)로 교체합니다.
73
+ 3. MCP 클라이언트를 재시작합니다.
74
+
75
+ Node.js 18 이상이 필요합니다. `ORCAROUTER_API_KEY` 환경 변수는 `orcarouter_chat`에만 필요하며, 카탈로그 도구는 키 없이도 작동합니다.
76
+
77
+ ## 도구
78
+
79
+ - `orcarouter_chat` — 채팅 완성을 실행 (선택적 폴백 체인 포함)
80
+ - `orcarouter_models_list` — 카탈로그 탐색 (가격, 컨텍스트, 기능)
81
+ - `orcarouter_model_card` — 특정 모델에 대한 상세 정보
82
+ - `orcarouter_providers_list` — 모델 수와 함께 프로바이더 목록 표시
83
+
84
+ 전체 입력 스키마는 MCP `tools/list` 메서드를 통해 런타임에 노출됩니다 — MCP 클라이언트(Claude Desktop, Cursor 등)가 이를 자동으로 읽어들입니다.
85
+
86
+ ## 설정
87
+
88
+ | Name | Required | Description |
89
+ | --------------------------- | -------- | -------------------------------------------------------- |
90
+ | `ORCAROUTER_API_KEY` | 선택 | OrcaRouter API 키. `orcarouter_chat`에만 필요합니다. |
91
+ | `ORCAROUTER_BASE_URL` | 선택 | API 기본 URL. 기본값은 `https://api.orcarouter.ai`입니다. |
92
+ | `ORCAROUTER_REQUEST_TIMEOUT`| 선택 | 요청당 HTTP 타임아웃(**초** 단위). 기본값은 `300`입니다. |
93
+
94
+ ## 보안
95
+
96
+ API 키는 환경 변수에서 읽어들이며, 로그에 기록되지 않고, OrcaRouter API로만 전송됩니다. 취약점 공개 정책은 [SECURITY.md](SECURITY.md)를 참조하세요.
97
+
98
+ ## 개발
99
+
100
+ ```sh
101
+ # bun (preferred)
102
+ bun install
103
+ bun run test
104
+ bun run typecheck
105
+ bun run build
106
+
107
+ # or with npm
108
+ npm install
109
+ npm test
110
+ npm run typecheck
111
+ npm run build
112
+ ```
113
+
114
+ 빌드는 `#!/usr/bin/env node` 셔뱅이 포함된 ESM 번들을 `dist/index.js`에 생성하며, `orcarouter-mcp` 바이너리로 실행할 수 있습니다.
115
+
116
+ ## 라이선스
117
+
118
+ [MIT](LICENSE)
package/README.md ADDED
@@ -0,0 +1,126 @@
1
+ <p align="center">
2
+ <a href="https://www.orcarouter.ai">
3
+ <img src="https://raw.githubusercontent.com/Continuum-AI-Corp/orcarouter-mcp-server/main/assets/logo.gif" alt="OrcaRouter" width="180" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">OrcaRouter MCP Server</h1>
8
+
9
+ <p align="center">
10
+ Official MCP server for the <a href="https://www.orcarouter.ai">OrcaRouter</a> LLM gateway.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://discord.com/invite/943Zqp9bs"><img src="https://img.shields.io/discord/1501106943178309662?logo=discord&label=discord&color=5865F2" alt="Discord" /></a>
15
+ <a href="https://x.com/OrcaRouter"><img src="https://img.shields.io/badge/X-Follow-000000?logo=x&logoColor=white" alt="X" /></a>
16
+ <a href="https://www.npmjs.com/package/@orcarouter/mcp"><img src="https://img.shields.io/npm/v/@orcarouter/mcp" alt="npm version" /></a>
17
+ <a href="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml"><img src="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml/badge.svg" alt="CI" /></a>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-CN.md">中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.fr.md">Français</a> | <a href="README.es.md">Español</a> | <a href="README.it.md">Italiano</a> | <a href="README.ru.md">Русский</a> | <a href="README.pt.md">Português</a> | <a href="README.vi.md">Tiếng Việt</a> | <a href="README.hi.md">हिन्दी</a>
22
+ </p>
23
+
24
+ <br/>
25
+
26
+ Browse [OrcaRouter](https://www.orcarouter.ai)'s model catalog and run chat
27
+ completions from inside any [Model Context Protocol](https://modelcontextprotocol.io)
28
+ client — Claude Desktop, Claude Code, Cursor, Windsurf, Zed, or anything
29
+ else that speaks the protocol.
30
+
31
+ Catalog browsing works **without an API key** — compare pricing and
32
+ capabilities before signing up.
33
+
34
+ ## What you can do
35
+
36
+ - 🗺️ Discover providers and models without an API key
37
+ - 💬 Run chat completions through any served model
38
+ - 🧠 Auto-route requests through your workspace's `orcarouter/auto` router (cost / quality / balanced / LinUCB / gated-adaptive strategies)
39
+ - 🔁 Configure fallback chains (primary + up to 4 fallbacks) for resilience
40
+ - 📊 Filter models server-side by provider, capability, or minimum context window
41
+ - 🎯 Inspect detailed model cards: pricing, context, latency, supported endpoints
42
+ - 🔌 Works with Claude Desktop, Claude Code, Cursor, Windsurf, Zed, and any MCP client
43
+
44
+ ## Examples
45
+
46
+ Try saying things like:
47
+
48
+ - *"List all providers on OrcaRouter"*
49
+ - *"Show me all Anthropic models with their pricing"*
50
+ - *"Get details about `minimax/minimax-m2.7`"*
51
+ - *"Chat with `orcarouter/auto` and explain quantum computing"*
52
+
53
+ ## Quick Start
54
+
55
+ ### Claude Code (CLI one-liner)
56
+
57
+ ```bash
58
+ claude mcp add orcarouter -s user \
59
+ -e ORCAROUTER_API_KEY=sk-orca-your-key \
60
+ -- npx -y @orcarouter/mcp
61
+ ```
62
+
63
+ ### Other clients (config-file path)
64
+
65
+ 1. Copy the example config for your MCP client into the client's config file:
66
+
67
+ | Client | Example | Action |
68
+ | --------------- | --------------------------------------------------- | ------- |
69
+ | Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | Replace |
70
+ | Claude Code | [claude-code.json](examples/claude-code.json) | Merge |
71
+ | Cursor | [cursor.json](examples/cursor.json) | Replace |
72
+ | Windsurf | [windsurf.json](examples/windsurf.json) | Replace |
73
+
74
+ See [`examples/README.md`](examples/README.md) for the config-file paths and notes on Zed and other clients.
75
+
76
+ 2. Replace `sk-or-...` in the copied file with your [OrcaRouter API key](https://www.orcarouter.ai/console).
77
+ 3. Restart your MCP client.
78
+
79
+ Requires Node.js 18 or later. The `ORCAROUTER_API_KEY` env var is only
80
+ required for `orcarouter_chat`; catalog tools work without it.
81
+
82
+ ## Tools
83
+
84
+ - `orcarouter_chat` — run a chat completion (with optional fallback chain)
85
+ - `orcarouter_models_list` — browse the catalog (pricing, context, capabilities)
86
+ - `orcarouter_model_card` — detailed info for one model
87
+ - `orcarouter_providers_list` — list providers with model counts
88
+
89
+ Full input schemas are exposed at runtime via the MCP `tools/list` method — your MCP client (Claude Desktop, Cursor, etc.) reads them automatically.
90
+
91
+ ## Configuration
92
+
93
+ | Name | Required | Description |
94
+ | --------------------------- | -------- | -------------------------------------------------------- |
95
+ | `ORCAROUTER_API_KEY` | optional | OrcaRouter API key. Required only for `orcarouter_chat`. |
96
+ | `ORCAROUTER_BASE_URL` | optional | API base URL. Defaults to `https://api.orcarouter.ai`. |
97
+ | `ORCAROUTER_REQUEST_TIMEOUT`| optional | Per-request HTTP timeout in **seconds**. Defaults to `300`. |
98
+
99
+ ## Security
100
+
101
+ API keys are read from environment variables, never logged, and only
102
+ sent to the OrcaRouter API. See [SECURITY.md](SECURITY.md) for the
103
+ vulnerability disclosure policy.
104
+
105
+ ## Development
106
+
107
+ ```sh
108
+ # bun (preferred)
109
+ bun install
110
+ bun run test
111
+ bun run typecheck
112
+ bun run build
113
+
114
+ # or with npm
115
+ npm install
116
+ npm test
117
+ npm run typecheck
118
+ npm run build
119
+ ```
120
+
121
+ The build produces an ESM bundle at `dist/index.js` with a
122
+ `#!/usr/bin/env node` shebang, runnable as the `orcarouter-mcp` binary.
123
+
124
+ ## License
125
+
126
+ [MIT](LICENSE)
package/README.pt.md ADDED
@@ -0,0 +1,126 @@
1
+ <p align="center">
2
+ <a href="https://www.orcarouter.ai">
3
+ <img src="https://raw.githubusercontent.com/Continuum-AI-Corp/orcarouter-mcp-server/main/assets/logo.gif" alt="OrcaRouter" width="180" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">OrcaRouter MCP Server</h1>
8
+
9
+ <p align="center">
10
+ Servidor MCP oficial para o gateway de LLM <a href="https://www.orcarouter.ai">OrcaRouter</a>.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://discord.com/invite/943Zqp9bs"><img src="https://img.shields.io/discord/1501106943178309662?logo=discord&label=discord&color=5865F2" alt="Discord" /></a>
15
+ <a href="https://x.com/OrcaRouter"><img src="https://img.shields.io/badge/X-Follow-000000?logo=x&logoColor=white" alt="X" /></a>
16
+ <a href="https://www.npmjs.com/package/@orcarouter/mcp"><img src="https://img.shields.io/npm/v/@orcarouter/mcp" alt="npm version" /></a>
17
+ <a href="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml"><img src="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml/badge.svg" alt="CI" /></a>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-CN.md">中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.fr.md">Français</a> | <a href="README.es.md">Español</a> | <a href="README.it.md">Italiano</a> | <a href="README.ru.md">Русский</a> | <a href="README.pt.md">Português</a> | <a href="README.vi.md">Tiếng Việt</a> | <a href="README.hi.md">हिन्दी</a>
22
+ </p>
23
+
24
+ <br/>
25
+
26
+ Explore o catálogo de modelos do [OrcaRouter](https://www.orcarouter.ai) e execute
27
+ chat completions de dentro de qualquer cliente [Model Context Protocol](https://modelcontextprotocol.io)
28
+ — Claude Desktop, Claude Code, Cursor, Windsurf, Zed ou qualquer outro
29
+ que fale o protocolo.
30
+
31
+ A navegação pelo catálogo funciona **sem chave de API** — compare preços e
32
+ capacidades antes de se cadastrar.
33
+
34
+ ## O que você pode fazer
35
+
36
+ - 🗺️ Descobrir provedores e modelos sem chave de API
37
+ - 💬 Executar chat completions através de qualquer modelo disponível
38
+ - 🧠 Roteamento automático de requisições pelo roteador `orcarouter/auto` do seu workspace (estratégias cost / quality / balanced / LinUCB / gated-adaptive)
39
+ - 🔁 Configurar cadeias de fallback (primário + até 4 fallbacks) para maior resiliência
40
+ - 📊 Filtrar modelos no lado do servidor por provedor, capacidade ou janela de contexto mínima
41
+ - 🎯 Inspecionar fichas detalhadas dos modelos: preços, contexto, latência, endpoints suportados
42
+ - 🔌 Funciona com Claude Desktop, Claude Code, Cursor, Windsurf, Zed e qualquer cliente MCP
43
+
44
+ ## Exemplos
45
+
46
+ Experimente dizer coisas como:
47
+
48
+ - *"List all providers on OrcaRouter"*
49
+ - *"Show me all Anthropic models with their pricing"*
50
+ - *"Get details about `minimax/minimax-m2.7`"*
51
+ - *"Chat with `orcarouter/auto` and explain quantum computing"*
52
+
53
+ ## Início rápido
54
+
55
+ ### Claude Code (one-liner via CLI)
56
+
57
+ ```bash
58
+ claude mcp add orcarouter -s user \
59
+ -e ORCAROUTER_API_KEY=sk-orca-your-key \
60
+ -- npx -y @orcarouter/mcp
61
+ ```
62
+
63
+ ### Outros clientes (caminho do arquivo de configuração)
64
+
65
+ 1. Copie a configuração de exemplo do seu cliente MCP para o arquivo de configuração do cliente:
66
+
67
+ | Cliente | Exemplo | Ação |
68
+ | --------------- | --------------------------------------------------- | ----------- |
69
+ | Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | Substituir |
70
+ | Claude Code | [claude-code.json](examples/claude-code.json) | Mesclar |
71
+ | Cursor | [cursor.json](examples/cursor.json) | Substituir |
72
+ | Windsurf | [windsurf.json](examples/windsurf.json) | Substituir |
73
+
74
+ Consulte [`examples/README.md`](examples/README.md) para os caminhos dos arquivos de configuração e observações sobre o Zed e outros clientes.
75
+
76
+ 2. Substitua `sk-or-...` no arquivo copiado pela sua [chave de API do OrcaRouter](https://www.orcarouter.ai/console).
77
+ 3. Reinicie o seu cliente MCP.
78
+
79
+ Requer Node.js 18 ou superior. A variável de ambiente `ORCAROUTER_API_KEY` é
80
+ necessária apenas para `orcarouter_chat`; as ferramentas de catálogo funcionam sem ela.
81
+
82
+ ## Ferramentas
83
+
84
+ - `orcarouter_chat` — executa um chat completion (com cadeia de fallback opcional)
85
+ - `orcarouter_models_list` — navega pelo catálogo (preços, contexto, capacidades)
86
+ - `orcarouter_model_card` — informações detalhadas de um modelo
87
+ - `orcarouter_providers_list` — lista provedores com a contagem de modelos
88
+
89
+ Os schemas de entrada completos são expostos em tempo de execução pelo método `tools/list` do MCP — seu cliente MCP (Claude Desktop, Cursor, etc.) os lê automaticamente.
90
+
91
+ ## Configuração
92
+
93
+ | Nome | Obrigatório | Descrição |
94
+ | --------------------------- | ----------- | ------------------------------------------------------------------ |
95
+ | `ORCAROUTER_API_KEY` | opcional | Chave de API do OrcaRouter. Necessária apenas para `orcarouter_chat`. |
96
+ | `ORCAROUTER_BASE_URL` | opcional | URL base da API. Padrão `https://api.orcarouter.ai`. |
97
+ | `ORCAROUTER_REQUEST_TIMEOUT`| opcional | Timeout HTTP por requisição em **segundos**. Padrão `300`. |
98
+
99
+ ## Segurança
100
+
101
+ As chaves de API são lidas de variáveis de ambiente, nunca são registradas em log e são
102
+ enviadas apenas para a API do OrcaRouter. Consulte [SECURITY.md](SECURITY.md) para a
103
+ política de divulgação de vulnerabilidades.
104
+
105
+ ## Desenvolvimento
106
+
107
+ ```sh
108
+ # bun (preferred)
109
+ bun install
110
+ bun run test
111
+ bun run typecheck
112
+ bun run build
113
+
114
+ # or with npm
115
+ npm install
116
+ npm test
117
+ npm run typecheck
118
+ npm run build
119
+ ```
120
+
121
+ O build gera um bundle ESM em `dist/index.js` com um
122
+ shebang `#!/usr/bin/env node`, executável como o binário `orcarouter-mcp`.
123
+
124
+ ## Licença
125
+
126
+ [MIT](LICENSE)
package/README.ru.md ADDED
@@ -0,0 +1,126 @@
1
+ <p align="center">
2
+ <a href="https://www.orcarouter.ai">
3
+ <img src="https://raw.githubusercontent.com/Continuum-AI-Corp/orcarouter-mcp-server/main/assets/logo.gif" alt="OrcaRouter" width="180" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">OrcaRouter MCP Server</h1>
8
+
9
+ <p align="center">
10
+ Официальный MCP-сервер для LLM-шлюза <a href="https://www.orcarouter.ai">OrcaRouter</a>.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://discord.com/invite/943Zqp9bs"><img src="https://img.shields.io/discord/1501106943178309662?logo=discord&label=discord&color=5865F2" alt="Discord" /></a>
15
+ <a href="https://x.com/OrcaRouter"><img src="https://img.shields.io/badge/X-Follow-000000?logo=x&logoColor=white" alt="X" /></a>
16
+ <a href="https://www.npmjs.com/package/@orcarouter/mcp"><img src="https://img.shields.io/npm/v/@orcarouter/mcp" alt="npm version" /></a>
17
+ <a href="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml"><img src="https://github.com/Continuum-AI-Corp/orcarouter-mcp-server/actions/workflows/test.yml/badge.svg" alt="CI" /></a>
18
+ </p>
19
+
20
+ <p align="center">
21
+ <a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-CN.md">中文</a> | <a href="README.ko.md">한국어</a> | <a href="README.de.md">Deutsch</a> | <a href="README.fr.md">Français</a> | <a href="README.es.md">Español</a> | <a href="README.it.md">Italiano</a> | <a href="README.ru.md">Русский</a> | <a href="README.pt.md">Português</a> | <a href="README.vi.md">Tiếng Việt</a> | <a href="README.hi.md">हिन्दी</a>
22
+ </p>
23
+
24
+ <br/>
25
+
26
+ Просматривайте каталог моделей [OrcaRouter](https://www.orcarouter.ai) и запускайте chat
27
+ completions из любого клиента [Model Context Protocol](https://modelcontextprotocol.io) —
28
+ Claude Desktop, Claude Code, Cursor, Windsurf, Zed или чего угодно ещё,
29
+ что говорит на этом протоколе.
30
+
31
+ Просмотр каталога работает **без API-ключа** — сравнивайте цены и
32
+ возможности до регистрации.
33
+
34
+ ## Что можно делать
35
+
36
+ - 🗺️ Открывайте для себя провайдеров и модели без API-ключа
37
+ - 💬 Запускайте chat completions через любую обслуживаемую модель
38
+ - 🧠 Автоматически маршрутизируйте запросы через роутер `orcarouter/auto` вашего workspace (стратегии cost / quality / balanced / LinUCB / gated-adaptive)
39
+ - 🔁 Настраивайте цепочки fallback (основная модель + до 4 запасных) для отказоустойчивости
40
+ - 📊 Фильтруйте модели на стороне сервера по провайдеру, возможностям или минимальному размеру контекстного окна
41
+ - 🎯 Изучайте подробные карточки моделей: цены, контекст, задержки, поддерживаемые эндпоинты
42
+ - 🔌 Работает с Claude Desktop, Claude Code, Cursor, Windsurf, Zed и любым MCP-клиентом
43
+
44
+ ## Примеры
45
+
46
+ Попробуйте сказать что-то вроде:
47
+
48
+ - *"Перечисли всех провайдеров на OrcaRouter"*
49
+ - *"Покажи все модели Anthropic с их ценами"*
50
+ - *"Получи детали о `minimax/minimax-m2.7`"*
51
+ - *"Поговори с `orcarouter/auto` и объясни квантовые вычисления"*
52
+
53
+ ## Быстрый старт
54
+
55
+ ### Claude Code (однострочная CLI-команда)
56
+
57
+ ```bash
58
+ claude mcp add orcarouter -s user \
59
+ -e ORCAROUTER_API_KEY=sk-orca-your-key \
60
+ -- npx -y @orcarouter/mcp
61
+ ```
62
+
63
+ ### Другие клиенты (через файл конфигурации)
64
+
65
+ 1. Скопируйте пример конфигурации для вашего MCP-клиента в файл конфигурации клиента:
66
+
67
+ | Клиент | Пример | Действие |
68
+ | --------------- | --------------------------------------------------- | ---------- |
69
+ | Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | Заменить |
70
+ | Claude Code | [claude-code.json](examples/claude-code.json) | Объединить |
71
+ | Cursor | [cursor.json](examples/cursor.json) | Заменить |
72
+ | Windsurf | [windsurf.json](examples/windsurf.json) | Заменить |
73
+
74
+ Смотрите [`examples/README.md`](examples/README.md), где указаны пути к файлам конфигурации и заметки про Zed и другие клиенты.
75
+
76
+ 2. Замените `sk-or-...` в скопированном файле на ваш [ключ OrcaRouter API](https://www.orcarouter.ai/console).
77
+ 3. Перезапустите MCP-клиент.
78
+
79
+ Требуется Node.js 18 или новее. Переменная окружения `ORCAROUTER_API_KEY` нужна
80
+ только для `orcarouter_chat`; инструменты каталога работают и без неё.
81
+
82
+ ## Инструменты
83
+
84
+ - `orcarouter_chat` — выполнить chat completion (с опциональной цепочкой fallback)
85
+ - `orcarouter_models_list` — просмотреть каталог (цены, контекст, возможности)
86
+ - `orcarouter_model_card` — подробная информация по одной модели
87
+ - `orcarouter_providers_list` — список провайдеров с количеством моделей
88
+
89
+ Полные схемы входных данных доступны во время выполнения через MCP-метод `tools/list` — ваш MCP-клиент (Claude Desktop, Cursor и т. д.) читает их автоматически.
90
+
91
+ ## Конфигурация
92
+
93
+ | Имя | Обязательность | Описание |
94
+ | --------------------------- | -------------- | -------------------------------------------------------------- |
95
+ | `ORCAROUTER_API_KEY` | необязательно | Ключ OrcaRouter API. Требуется только для `orcarouter_chat`. |
96
+ | `ORCAROUTER_BASE_URL` | необязательно | Базовый URL API. По умолчанию `https://api.orcarouter.ai`. |
97
+ | `ORCAROUTER_REQUEST_TIMEOUT`| необязательно | HTTP-таймаут на запрос в **секундах**. По умолчанию `300`. |
98
+
99
+ ## Безопасность
100
+
101
+ API-ключи считываются из переменных окружения, никогда не логируются и
102
+ отправляются только в OrcaRouter API. См. [SECURITY.md](SECURITY.md) для
103
+ ознакомления с политикой раскрытия уязвимостей.
104
+
105
+ ## Разработка
106
+
107
+ ```sh
108
+ # bun (предпочтительный)
109
+ bun install
110
+ bun run test
111
+ bun run typecheck
112
+ bun run build
113
+
114
+ # или через npm
115
+ npm install
116
+ npm test
117
+ npm run typecheck
118
+ npm run build
119
+ ```
120
+
121
+ Сборка создаёт ESM-бандл в `dist/index.js` с shebang
122
+ `#!/usr/bin/env node`, который запускается как бинарь `orcarouter-mcp`.
123
+
124
+ ## Лицензия
125
+
126
+ [MIT](LICENSE)