docs: add supported providers section and clarify contributing guidelines
- Add Supported Providers table with 4 verified providers (Anthropic, OpenAI, Copilot, Ollama) and note that other OpenAI-compatible providers are unverified - Update Contributing to distinguish baseURL verification (#25) from new adapters - Note that local models via Ollama require no API key in Quick Start
This commit is contained in:
parent
24a2c4fe1a
commit
8d27c6a1fe
15
README.md
15
README.md
|
|
@ -26,7 +26,7 @@ Requires Node.js >= 18.
|
||||||
npm install @jackchen_me/open-multi-agent
|
npm install @jackchen_me/open-multi-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
Set `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY` or `GITHUB_TOKEN` for Copilot) in your environment.
|
Set `ANTHROPIC_API_KEY` (and optionally `OPENAI_API_KEY` or `GITHUB_TOKEN` for Copilot) in your environment. Local models via Ollama require no API key — see [example 06](examples/06-local-model.ts).
|
||||||
|
|
||||||
Three agents, one goal — the framework handles the rest:
|
Three agents, one goal — the framework handles the rest:
|
||||||
|
|
||||||
|
|
@ -173,11 +173,22 @@ npx tsx examples/01-single-agent.ts
|
||||||
| `file_edit` | Edit a file by replacing an exact string match. |
|
| `file_edit` | Edit a file by replacing an exact string match. |
|
||||||
| `grep` | Search file contents with regex. Uses ripgrep when available, falls back to Node.js. |
|
| `grep` | Search file contents with regex. Uses ripgrep when available, falls back to Node.js. |
|
||||||
|
|
||||||
|
## Supported Providers
|
||||||
|
|
||||||
|
| Provider | Config | Env var | Status |
|
||||||
|
|----------|--------|---------|--------|
|
||||||
|
| Anthropic (Claude) | `provider: 'anthropic'` | `ANTHROPIC_API_KEY` | Verified |
|
||||||
|
| OpenAI (GPT) | `provider: 'openai'` | `OPENAI_API_KEY` | Verified |
|
||||||
|
| GitHub Copilot | `provider: 'copilot'` | `GITHUB_TOKEN` | Verified |
|
||||||
|
| Ollama / vLLM / LM Studio | `provider: 'openai'` + `baseURL` | — | Verified |
|
||||||
|
|
||||||
|
Any OpenAI-compatible API should work via `provider: 'openai'` + `baseURL` (DeepSeek, Groq, Mistral, Qwen, MiniMax, etc.). These providers have not been fully verified yet — contributions welcome via [#25](https://github.com/JackChen-me/open-multi-agent/issues/25).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Issues, feature requests, and PRs are welcome. Some areas where contributions would be especially valuable:
|
Issues, feature requests, and PRs are welcome. Some areas where contributions would be especially valuable:
|
||||||
|
|
||||||
- **LLM Adapters** — Anthropic, OpenAI, and Copilot are supported out of the box. Any OpenAI-compatible API (Ollama, vLLM, LM Studio, etc.) works via `baseURL`. Additional adapters for Gemini and other providers are welcome. The `LLMAdapter` interface requires just two methods: `chat()` and `stream()`.
|
- **Provider integrations** — Verify and document OpenAI-compatible providers (DeepSeek, Groq, Qwen, MiniMax, etc.) via `baseURL`. See [#25](https://github.com/JackChen-me/open-multi-agent/issues/25). For providers that are NOT OpenAI-compatible (e.g. Gemini), a new `LLMAdapter` implementation is welcome — the interface requires just two methods: `chat()` and `stream()`.
|
||||||
- **Examples** — Real-world workflows and use cases.
|
- **Examples** — Real-world workflows and use cases.
|
||||||
- **Documentation** — Guides, tutorials, and API docs.
|
- **Documentation** — Guides, tutorials, and API docs.
|
||||||
|
|
||||||
|
|
|
||||||
15
README_zh.md
15
README_zh.md
|
|
@ -26,7 +26,7 @@
|
||||||
npm install @jackchen_me/open-multi-agent
|
npm install @jackchen_me/open-multi-agent
|
||||||
```
|
```
|
||||||
|
|
||||||
在环境变量中设置 `ANTHROPIC_API_KEY`(以及可选的 `OPENAI_API_KEY` 或用于 Copilot 的 `GITHUB_TOKEN`)。
|
在环境变量中设置 `ANTHROPIC_API_KEY`(以及可选的 `OPENAI_API_KEY` 或用于 Copilot 的 `GITHUB_TOKEN`)。通过 Ollama 使用本地模型无需 API key — 参见 [example 06](examples/06-local-model.ts)。
|
||||||
|
|
||||||
三个智能体,一个目标——框架处理剩下的一切:
|
三个智能体,一个目标——框架处理剩下的一切:
|
||||||
|
|
||||||
|
|
@ -177,11 +177,22 @@ npx tsx examples/01-single-agent.ts
|
||||||
| `file_edit` | 通过精确字符串匹配编辑文件。 |
|
| `file_edit` | 通过精确字符串匹配编辑文件。 |
|
||||||
| `grep` | 使用正则表达式搜索文件内容。优先使用 ripgrep,回退到 Node.js 实现。 |
|
| `grep` | 使用正则表达式搜索文件内容。优先使用 ripgrep,回退到 Node.js 实现。 |
|
||||||
|
|
||||||
|
## 支持的 Provider
|
||||||
|
|
||||||
|
| Provider | 配置 | 环境变量 | 状态 |
|
||||||
|
|----------|------|----------|------|
|
||||||
|
| Anthropic (Claude) | `provider: 'anthropic'` | `ANTHROPIC_API_KEY` | 已验证 |
|
||||||
|
| OpenAI (GPT) | `provider: 'openai'` | `OPENAI_API_KEY` | 已验证 |
|
||||||
|
| GitHub Copilot | `provider: 'copilot'` | `GITHUB_TOKEN` | 已验证 |
|
||||||
|
| Ollama / vLLM / LM Studio | `provider: 'openai'` + `baseURL` | — | 已验证 |
|
||||||
|
|
||||||
|
任何 OpenAI 兼容 API 均可通过 `provider: 'openai'` + `baseURL` 接入(DeepSeek、Groq、Mistral、Qwen、MiniMax 等)。这些 Provider 尚未完整验证——欢迎通过 [#25](https://github.com/JackChen-me/open-multi-agent/issues/25) 贡献验证。
|
||||||
|
|
||||||
## 参与贡献
|
## 参与贡献
|
||||||
|
|
||||||
欢迎提 Issue、功能需求和 PR。以下方向的贡献尤其有价值:
|
欢迎提 Issue、功能需求和 PR。以下方向的贡献尤其有价值:
|
||||||
|
|
||||||
- **LLM 适配器** — Anthropic、OpenAI、Copilot 已原生支持。任何 OpenAI 兼容 API(Ollama、vLLM、LM Studio 等)可通过 `baseURL` 直接使用。欢迎贡献 Gemini 等其他适配器。`LLMAdapter` 接口只需实现两个方法:`chat()` 和 `stream()`。
|
- **Provider 集成** — 验证并文档化 OpenAI 兼容 Provider(DeepSeek、Groq、Qwen、MiniMax 等)通过 `baseURL` 接入。详见 [#25](https://github.com/JackChen-me/open-multi-agent/issues/25)。对于非 OpenAI 兼容的 Provider(如 Gemini),欢迎贡献新的 `LLMAdapter` 实现——接口只需两个方法:`chat()` 和 `stream()`。
|
||||||
- **示例** — 真实场景的工作流和用例。
|
- **示例** — 真实场景的工作流和用例。
|
||||||
- **文档** — 指南、教程和 API 文档。
|
- **文档** — 指南、教程和 API 文档。
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue