@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.
- package/LICENSE +21 -0
- package/README.de.md +118 -0
- package/README.es.md +126 -0
- package/README.fr.md +126 -0
- package/README.hi.md +126 -0
- package/README.it.md +127 -0
- package/README.ja.md +123 -0
- package/README.ko.md +118 -0
- package/README.md +126 -0
- package/README.pt.md +126 -0
- package/README.ru.md +126 -0
- package/README.vi.md +126 -0
- package/README.zh-CN.md +122 -0
- package/assets/logo.gif +0 -0
- package/dist/index.js +736 -0
- package/dist/index.js.map +1 -0
- package/package.json +55 -0
package/README.vi.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 server chính thức cho cổng 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
|
+
Duyệt danh mục mô hình của [OrcaRouter](https://www.orcarouter.ai) và chạy
|
|
27
|
+
chat completion ngay bên trong bất kỳ client [Model Context Protocol](https://modelcontextprotocol.io)
|
|
28
|
+
nào — Claude Desktop, Claude Code, Cursor, Windsurf, Zed, hoặc bất cứ
|
|
29
|
+
ứng dụng nào nói giao thức này.
|
|
30
|
+
|
|
31
|
+
Duyệt danh mục hoạt động **không cần API key** — so sánh giá và
|
|
32
|
+
khả năng trước khi đăng ký.
|
|
33
|
+
|
|
34
|
+
## Bạn có thể làm gì
|
|
35
|
+
|
|
36
|
+
- 🗺️ Khám phá các provider và mô hình mà không cần API key
|
|
37
|
+
- 💬 Chạy chat completion qua bất kỳ mô hình nào đang phục vụ
|
|
38
|
+
- 🧠 Tự động định tuyến yêu cầu qua router `orcarouter/auto` của workspace của bạn (các chiến lược cost / quality / balanced / LinUCB / gated-adaptive)
|
|
39
|
+
- 🔁 Cấu hình chuỗi fallback (chính + tối đa 4 fallback) để đảm bảo độ tin cậy
|
|
40
|
+
- 📊 Lọc mô hình ở phía server theo provider, khả năng, hoặc cửa sổ ngữ cảnh tối thiểu
|
|
41
|
+
- 🎯 Kiểm tra model card chi tiết: giá, ngữ cảnh, độ trễ, các endpoint được hỗ trợ
|
|
42
|
+
- 🔌 Hoạt động với Claude Desktop, Claude Code, Cursor, Windsurf, Zed, và mọi client MCP
|
|
43
|
+
|
|
44
|
+
## Ví dụ
|
|
45
|
+
|
|
46
|
+
Hãy thử nói những câu như:
|
|
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
|
+
## Bắt đầu nhanh
|
|
54
|
+
|
|
55
|
+
### Claude Code (lệnh CLI một dòng)
|
|
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
|
+
### Các client khác (đường dẫn file cấu hình)
|
|
64
|
+
|
|
65
|
+
1. Sao chép cấu hình mẫu cho client MCP của bạn vào file cấu hình của client:
|
|
66
|
+
|
|
67
|
+
| Client | Ví dụ | Hành động |
|
|
68
|
+
| --------------- | --------------------------------------------------- | --------- |
|
|
69
|
+
| Claude Desktop | [claude-desktop.json](examples/claude-desktop.json) | Thay thế |
|
|
70
|
+
| Claude Code | [claude-code.json](examples/claude-code.json) | Gộp |
|
|
71
|
+
| Cursor | [cursor.json](examples/cursor.json) | Thay thế |
|
|
72
|
+
| Windsurf | [windsurf.json](examples/windsurf.json) | Thay thế |
|
|
73
|
+
|
|
74
|
+
Xem [`examples/README.md`](examples/README.md) để biết các đường dẫn file cấu hình và lưu ý về Zed cùng các client khác.
|
|
75
|
+
|
|
76
|
+
2. Thay `sk-or-...` trong file đã sao chép bằng [API key OrcaRouter](https://www.orcarouter.ai/console) của bạn.
|
|
77
|
+
3. Khởi động lại client MCP của bạn.
|
|
78
|
+
|
|
79
|
+
Yêu cầu Node.js 18 trở lên. Biến môi trường `ORCAROUTER_API_KEY` chỉ
|
|
80
|
+
bắt buộc cho `orcarouter_chat`; các công cụ danh mục hoạt động mà không cần nó.
|
|
81
|
+
|
|
82
|
+
## Công cụ
|
|
83
|
+
|
|
84
|
+
- `orcarouter_chat` — chạy một chat completion (với chuỗi fallback tùy chọn)
|
|
85
|
+
- `orcarouter_models_list` — duyệt danh mục (giá, ngữ cảnh, khả năng)
|
|
86
|
+
- `orcarouter_model_card` — thông tin chi tiết cho một mô hình
|
|
87
|
+
- `orcarouter_providers_list` — liệt kê các provider kèm số lượng mô hình
|
|
88
|
+
|
|
89
|
+
Các schema đầu vào đầy đủ được phơi ra trong thời gian chạy thông qua phương thức MCP `tools/list` — client MCP của bạn (Claude Desktop, Cursor, v.v.) đọc chúng tự động.
|
|
90
|
+
|
|
91
|
+
## Cấu hình
|
|
92
|
+
|
|
93
|
+
| Tên | Bắt buộc | Mô tả |
|
|
94
|
+
| --------------------------- | --------- | -------------------------------------------------------- |
|
|
95
|
+
| `ORCAROUTER_API_KEY` | tùy chọn | API key OrcaRouter. Chỉ bắt buộc cho `orcarouter_chat`. |
|
|
96
|
+
| `ORCAROUTER_BASE_URL` | tùy chọn | URL gốc của API. Mặc định là `https://api.orcarouter.ai`.|
|
|
97
|
+
| `ORCAROUTER_REQUEST_TIMEOUT`| tùy chọn | Thời gian chờ HTTP cho mỗi yêu cầu tính bằng **giây**. Mặc định là `300`. |
|
|
98
|
+
|
|
99
|
+
## Bảo mật
|
|
100
|
+
|
|
101
|
+
API key được đọc từ biến môi trường, không bao giờ được ghi log, và chỉ
|
|
102
|
+
được gửi đến API của OrcaRouter. Xem [SECURITY.md](SECURITY.md) để biết
|
|
103
|
+
chính sách công bố lỗ hổng.
|
|
104
|
+
|
|
105
|
+
## Phát triển
|
|
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
|
+
Quá trình build tạo ra một ESM bundle tại `dist/index.js` với shebang
|
|
122
|
+
`#!/usr/bin/env node`, có thể chạy như binary `orcarouter-mcp`.
|
|
123
|
+
|
|
124
|
+
## Giấy phép
|
|
125
|
+
|
|
126
|
+
[MIT](LICENSE)
|
package/README.zh-CN.md
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
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 server。
|
|
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
|
+
在任意 [Model Context Protocol](https://modelcontextprotocol.io) 客户端中浏览
|
|
27
|
+
[OrcaRouter](https://www.orcarouter.ai) 的模型目录并运行对话补全 ——
|
|
28
|
+
Claude Desktop、Claude Code、Cursor、Windsurf、Zed,或任何支持该协议的客户端皆可。
|
|
29
|
+
|
|
30
|
+
目录浏览**无需 API key** —— 注册前即可比较定价与能力。
|
|
31
|
+
|
|
32
|
+
## 功能一览
|
|
33
|
+
|
|
34
|
+
- 🗺️ 无需 API key 即可发现 providers 与模型
|
|
35
|
+
- 💬 通过任意已上线的模型运行对话补全
|
|
36
|
+
- 🧠 通过工作区的 `orcarouter/auto` 路由器自动选模(成本 / 质量 / 均衡 / LinUCB / gated-adaptive 等策略)
|
|
37
|
+
- 🔁 配置回退链(主模型 + 最多 4 个 fallback)以提升可靠性
|
|
38
|
+
- 📊 在服务端按 provider、能力或最小上下文窗口过滤模型
|
|
39
|
+
- 🎯 查看详细的模型卡片:定价、上下文、延迟、支持的端点
|
|
40
|
+
- 🔌 适配 Claude Desktop、Claude Code、Cursor、Windsurf、Zed,以及任意 MCP 客户端
|
|
41
|
+
|
|
42
|
+
## 使用示例
|
|
43
|
+
|
|
44
|
+
可以这样对你的 agent 说:
|
|
45
|
+
|
|
46
|
+
- *"列出 OrcaRouter 上的所有 providers"*
|
|
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
|
+
| 客户端 | 示例 | 操作 |
|
|
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` 时必填;目录类工具无需 API key 即可使用。
|
|
79
|
+
|
|
80
|
+
## 工具
|
|
81
|
+
|
|
82
|
+
- `orcarouter_chat` — 运行对话补全(可选配置回退链)
|
|
83
|
+
- `orcarouter_models_list` — 浏览目录(定价、上下文、能力)
|
|
84
|
+
- `orcarouter_model_card` — 单个模型的详细信息
|
|
85
|
+
- `orcarouter_providers_list` — 列出 providers 及对应模型数量
|
|
86
|
+
|
|
87
|
+
完整的输入 schema 会在运行时通过 MCP 的 `tools/list` 方法暴露 —— 你的 MCP 客户端(Claude Desktop、Cursor 等)会自动读取。
|
|
88
|
+
|
|
89
|
+
## 配置
|
|
90
|
+
|
|
91
|
+
| 名称 | 是否必填 | 说明 |
|
|
92
|
+
| --------------------------- | -------- | ------------------------------------------------------------ |
|
|
93
|
+
| `ORCAROUTER_API_KEY` | 可选 | OrcaRouter API key。仅 `orcarouter_chat` 需要。 |
|
|
94
|
+
| `ORCAROUTER_BASE_URL` | 可选 | API base URL。默认值为 `https://api.orcarouter.ai`。 |
|
|
95
|
+
| `ORCAROUTER_REQUEST_TIMEOUT`| 可选 | 单次请求的 HTTP 超时时间,单位为**秒**。默认值为 `300`。 |
|
|
96
|
+
|
|
97
|
+
## 安全
|
|
98
|
+
|
|
99
|
+
API key 仅从环境变量读取,不会被记录到日志,且只会发送给 OrcaRouter API。漏洞披露策略详见 [SECURITY.md](SECURITY.md)。
|
|
100
|
+
|
|
101
|
+
## 开发
|
|
102
|
+
|
|
103
|
+
```sh
|
|
104
|
+
# bun(推荐)
|
|
105
|
+
bun install
|
|
106
|
+
bun run test
|
|
107
|
+
bun run typecheck
|
|
108
|
+
bun run build
|
|
109
|
+
|
|
110
|
+
# 或使用 npm
|
|
111
|
+
npm install
|
|
112
|
+
npm test
|
|
113
|
+
npm run typecheck
|
|
114
|
+
npm run build
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
构建会在 `dist/index.js` 产出一个带 `#!/usr/bin/env node` shebang 的 ESM bundle,
|
|
118
|
+
可作为 `orcarouter-mcp` 二进制运行。
|
|
119
|
+
|
|
120
|
+
## 许可证
|
|
121
|
+
|
|
122
|
+
[MIT](LICENSE)
|
package/assets/logo.gif
ADDED
|
Binary file
|