boos/BoosAPI
2
0
Fork 2
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(desktop): embed BoosAPI Desktop client as a subproject

Browse Source 
Vendor the rebranded BoosAPI Desktop client (Tauri + Vue) into metapi as
a monorepo subdirectory under desktop/. Source only — node_modules,
dist, Cargo target and the upstream .git history are excluded.

desktop/ keeps its own independent Cargo workspace (desktop/src-tauri
with crates/*); it is not part of the backend boosapi crate, so a
`cargo check` at the metapi root still compiles only the backend. Build
the desktop app from desktop/src-tauri per desktop/README.md.

Note: app icons are still placeholder assets pending the final BoosAPI
logo. The updater signing keys live outside the repo and are not
included.
This commit is contained in:
boos
2026-06-22 11:32:57 +08:00
parent d9c78ecc73
commit e0a5f57793
2305 changed files with 449355 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
desktop/website/docs/ja/download.md
+5
View File
@@ -0,0 +1,5 @@
---
layout: page
---
<DownloadHero />
desktop/website/docs/ja/features.md
+52
View File
@@ -0,0 +1,52 @@
# 機能一覧
BoosApi はローカルファーストの AI デスクトップワークスペースです。このページは v0.0.85 に合わせて、プロバイダー導入、外部データインポート、MCP、HTML レンダリング、バックアップ、ゲートウェイ機能を更新しています。
## チャットとモデル
- **マルチプロバイダー対応** — OpenAI、Claude、Gemini、DeepSeek、Qwen、OpenAI 互換エンドポイントを、Base URL、API Path、ヘッダー、プロキシ設定付きで接続できます。
- **プロバイダー導入** — boosapi:// プロバイダーリンクと CC Switch インポートで、ユーザー確認後にプロバイダー設定を取り込めます。
- **モデル管理** — リモートモデル同期、グループ管理、レイテンシーテスト、能力タグ、コンテキスト長、サンプリング既定値、推論プロファイル、モデル別 extra_body を設定できます。
- **会話ワークフロー** — ストリーミング返信、思考ブロック、メッセージバージョン、会話分岐、タイトル生成状態、長文圧縮、複数モデル並列回答に対応します。
## AI Agent
- **Agent モード** — 制御されたデスクトップワークフロー内で、モデルにファイル編集、コマンド実行、コード分析を任せられます。
- **権限制御** — 標準レビュー、自動編集承認、フルアクセスを選べ、作業ディレクトリのサンドボックスチェックは維持されます。
- **承認とコスト UI** — ツール呼び出しをリアルタイムで確認し、許可判断を記憶し、各 Agent セッションの token とコストを追跡できます。
## コンテンツレンダリング
- **Markdown と数式** — ストリーミング会話で Markdown、コードハイライト、表、タスクリスト、LaTeX 数式を表示します。
- **コード、図、Artifact** — Monaco コードブロック、Mermaid、D2、Artifact パネルでコード、Markdown メモ、レポート、プレビューを扱えます。
- **HTML フラグメント** — 生成された HTML 断片を安全にプレビューし、最近のリリースで追加されたストリーミング安定化も反映しています。
## 検索とナレッジ
- **Web 検索** — Tavily、Zhipu WebSearch、Bocha などを使い、引用元と検索クエリ生成を会話に追加できます。
- **ローカルナレッジベース** — sqlite-vec で非公開ドキュメントを索引化し、取得/リランク設定と検索フィードバックを確認できます。
- **コンテキスト管理** — ファイル、検索結果、ナレッジ断片、メモリ、ツール出力を会話コンテキストへ追加できます。
## ツールと拡張機能
- **MCP プロトコル** — stdio、SSE、StreamableHTTP の Model Context Protocol サーバーを実行できます。
- **ビルトインツール** — @boosapi/fetch やファイル検索などの内蔵 MCP ツールを、追加サーバーなしで利用できます。
- **ツールループ上限** — MCP ツール呼び出しの最大ループ数を設定し、中断や停止したツールセッションから復帰しやすくなりました。
## API ゲートウェイ
- **ローカルゲートウェイ** — デスクトップアプリから OpenAI Chat Completions、OpenAI Responses、Claude ネイティブ、Gemini ネイティブ API を公開します。
- **アクセスと可観測性** — ゲートウェイキー、SSL/TLS 証明書、リクエストログ、利用統計をローカルで管理できます。
- **クライアントテンプレート** — Claude Code、Codex CLI、OpenCode、Gemini CLI、カスタムクライアント向けのテンプレートを提供します。
## データインポートとバックアップ
- **サードパーティインポート** — ChatGPT 公式エクスポート、Cherry Studio、Kelivo バックアップをプレビュー、警告、重複処理付きで取り込めます。
- **プロバイダーとファイル移行** — Cherry Studio/Kelivo から関連プロバイダー、API キー、添付ファイルを任意で移行できます。
- **バックアップ** — ローカルフォルダー、WebDAV、S3 互換ストレージでバックアップと復元を行えます。
## デスクトップとセキュリティ
- **ローカル暗号化** — アプリ状態は ~/.boosapi/、ユーザーファイルは ~/Documents/boosapi/ に保存され、API キーは AES-256 とローカルマスターキーで保護されます。
- **デスクトップ統合** — トレイ、常に手前、グローバルショートカット、自動起動、プロキシ、自動更新チェックをサポートします。
- **11 言語 UI** — 簡体字中国語、繁体字中国語、英語、日本語、韓国語、フランス語、ドイツ語、スペイン語、ロシア語、ヒンディー語、アラビア語を切り替えられます。
desktop/website/docs/ja/guide/gateway.md
+171
View File
@@ -0,0 +1,171 @@
# API ゲートウェイ
## API ゲートウェイとは？
BoosApi にはビルトインのローカル API サーバーが含まれており、設定されたプロバイダーを **OpenAI 互換**、**Claude ネイティブ**、**Gemini ネイティブ**エンドポイントとして公開します。これらのプロトコルのいずれかを使用するツールやクライアントは、BoosApi をバックエンドとして使用できます — 別の API キーやリレーサービスは不要です。
ユースケース：
- **Claude Code CLI**、**OpenAI Codex CLI**、**Gemini CLI**、**OpenCode** を BoosApi 経由で実行。
- IDE 拡張機能を単一のローカル管理エンドポイントに接続。
- 1 セットのプロバイダーキーをキーごとのレート制限で多くのツールで共有。
---
## はじめに
1. **設定 → API ゲートウェイ**を開きます（または <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> を押します）。
2. **起動**をクリックしてゲートウェイサーバーを起動します。
3. デフォルトでは、サーバーは `127.0.0.1:8080`（HTTP）でリッスンします。**設定**タブでリッスンアドレスとポートを変更できます。
::: tip
ゲートウェイ設定で**自動起動**を有効にすると、BoosApi 起動時にサーバーが自動的に起動します。
:::
---
## API キー管理
ゲートウェイは、プロバイダーキーとは別に独自の API キーで受信リクエストを認証します。
1. **API キー**タブに移動します。
2. **新しいキーを生成**をクリックします。
3. 各キーを識別するためにオプションで**説明**を追加します（例：*Claude Code*、*VS Code*）。
4. キーをコピーします — 一度しか表示されません。
各キーには**プレフィックス**、**作成日**、**最終使用**タイムスタンプが表示されます。キーはいつでも**有効化/無効化**または**削除**できます。
::: warning
ゲートウェイキーは他の API キーと同様に扱ってください。キーを持つ人は誰でも、ゲートウェイが実行中にローカルゲートウェイにリクエストを送信できます。
:::
---
## SSL/TLS
ゲートウェイは HTTP の他に HTTPS を提供できます。
### 自動生成証明書
1. **設定**タブを開きます。
2. **SSL/TLS** を有効にして**生成**モードを選択します。
3. BoosApi が自己署名証明書と秘密鍵を以下に作成します：
```
~/.boosapi/ssl/cert.pem
~/.boosapi/ssl/key.pem
```
4. **HTTPS ポート**を設定します（デフォルト `8443`）。
5. オプションで**SSL 強制**を有効にして、すべての HTTP リクエストを HTTPS にリダイレクトします。
### カスタム証明書
**アップロード**モードを選択して、独自の証明書と秘密鍵ファイルのパスを提供します。
::: info
秘密鍵は Unix システムではファイルモード `0600` で保存され、他のユーザーが読み取れないようにします。
:::
---
## 使用状況分析
**メトリクス**タブにはゲートウェイアクティビティを監視するためのダッシュボードが表示されます：
| ビュー | 説明 |
|--------|------|
| **API キー別** | 各ゲートウェイキーによるリクエスト量とトークン使用量 |
| **プロバイダー別** | 各アップストリーム AI プロバイダーへのリクエストとトークン |
| **日別** | 時間経過による日次使用トレンド |
これらのダッシュボードを使用してコストを追跡し、異常を発見し、プロバイダー間で負荷を分散します。
---
## リクエストログ
**概要**タブには以下の詳細を含む最近のリクエストログが表示されます：
- **タイムスタンプ**、**HTTP メソッド**、**パス**
- **ステータスコード**と**レスポンスタイム**
- 使用された**プロバイダー**と**モデル**
- **トークン数**（プロンプト + 補完）
任意のログエントリをクリックして完全なリクエストとレスポンスを確認します。**ログをクリア**ボタンでログ履歴をリセットします。
---
## 設定テンプレート
BoosApi には人気の CLI ツール用の既製設定スニペットが付属しています。**テンプレート**タブに移動し、ツールを選択して**コピー**をクリックして必要な設定を取得します。
### Claude Code CLI
```bash
claude config set --global apiUrl http://127.0.0.1:8080
claude config set --global apiKey boosapi-xxxx
```
### OpenAI Codex CLI
```bash
export OPENAI_BASE_URL=http://127.0.0.1:8080/v1
export OPENAI_API_KEY=boosapi-xxxx
codex
```
### OpenCode
OpenCode 設定に追加します：
```json
{
"provider": "openai",
"baseURL": "http://127.0.0.1:8080/v1",
"apiKey": "boosapi-xxxx"
}
```
### Gemini CLI
```bash
export GEMINI_API_BASE=http://127.0.0.1:8080
export GEMINI_API_KEY=boosapi-xxxx
gemini
```
### カスタムクライアント
OpenAI 互換のベース URL を受け入れるツールはゲートウェイに接続できます：
```
Base URL: http://127.0.0.1:8080/v1
API Key: boosapi-xxxx
```
`boosapi-xxxx` を **API キー**タブで生成したキーに置き換えます。SSL が有効な場合は `https://` とポート `8443`（または設定した HTTPS ポート）を使用します。
---
## 外部ツールの接続
以下は OpenAI 互換クライアントを接続するための一般的なパターンです：
1. BoosApi で**ゲートウェイ API キーを生成**します。
2. ツールの設定で**ベース URL** を `http://127.0.0.1:8080/v1`（または HTTPS の同等）に設定します。
3. **API キー**を生成したゲートウェイキーに設定します。
4. BoosApi プロバイダーのいずれかに設定した**モデルを選択**します。
5. ツールを使用し始めます — すべてのリクエストは BoosApi を経由してアップストリームプロバイダーにルーティングされます。
::: tip
ツールが特定の API 形式（例：Claude または Gemini ネイティブ）を必要とする場合、BoosApi はリクエスト形式を自動的に検出して正しいプロバイダーにルーティングします。形式ごとに別のエンドポイントを設定する必要はありません。
:::
---
## 次のステップ
- [クイックスタート](./getting-started) — クイックスタートガイドに戻る
- [プロバイダーの設定](./providers) — ゲートウェイがルーティングするアップストリームプロバイダーの追加
- [MCP サーバー](./mcp) — AI ツール呼び出しのための外部ツールの接続
desktop/website/docs/ja/guide/getting-started.md
+197
View File
@@ -0,0 +1,197 @@
# クイックスタート
## インストール
[ダウンロードページ](/ja/download) または [GitHub Releases](https://github.com/BoosApi-Desktop/BoosApi/releases) から最新のインストーラーをダウンロードしてください。
### macOS
| チップ | ファイル |
|--------|---------|
| Apple Silicon (M1 / M2 / M3 / M4) | `BoosApi_x.x.x_aarch64.dmg` |
| Intel | `BoosApi_x.x.x_x64.dmg` |
1. `.dmg` を開き、**BoosApi** を**アプリケーション**フォルダにドラッグします。
2. BoosApi を起動します。macOS がアプリをブロックした場合は、**システム設定 → プライバシーとセキュリティ**に移動して**このまま開く**をクリックしてください。
::: warning macOS: 「アプリが壊れている」または「開発元を確認できない」
これらのメッセージのいずれかが表示された場合は、ターミナルを開いて以下を実行してください：
```bash
xattr -c /Applications/BoosApi.app
```
その後、アプリを再度起動します。これにより、macOS が未署名のダウンロードに適用する検疫フラグが削除されます。
:::
### Windows
| アーキテクチャ | ファイル |
|--------------|---------|
| x64（ほとんどの PC） | `BoosApi_x.x.x_x64-setup.exe` |
| ARM64 | `BoosApi_x.x.x_arm64-setup.exe` |
インストーラーを実行してウィザードに従います。スタートメニューまたはデスクトップショートカットから BoosApi を起動します。
### Linux
| 形式 | アーキテクチャ | ファイル |
|------|--------------|---------|
| Debian / Ubuntu | x64 | `BoosApi_x.x.x_amd64.deb` |
| Debian / Ubuntu | ARM64 | `BoosApi_x.x.x_arm64.deb` |
| Fedora / openSUSE | x64 | `BoosApi_x.x.x_x86_64.rpm` |
| Fedora / openSUSE | ARM64 | `BoosApi_x.x.x_aarch64.rpm` |
| 任意のディストリビューション | x64 | `BoosApi_x.x.x_amd64.AppImage` |
| 任意のディストリビューション | ARM64 | `BoosApi_x.x.x_aarch64.AppImage` |
```bash
# Debian / Ubuntu
sudo dpkg -i BoosApi_x.x.x_amd64.deb
# Fedora / openSUSE
sudo rpm -i BoosApi_x.x.x_x86_64.rpm
# AppImage（任意のディストリビューション）
chmod +x BoosApi_x.x.x_amd64.AppImage
./BoosApi_x.x.x_amd64.AppImage
```
---
## 初期設定
### 1. 設定を開く
BoosApi を起動し、サイドバー下部の**歯車アイコン**をクリックするか、<kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> を押します。
### 2. プロバイダーを追加する
**設定 → プロバイダー**に移動し、**+** ボタンをクリックします。
1. 表示名を入力します（例：*OpenAI*）。
2. プロバイダータイプを選択します（OpenAI、Anthropic、Google Gemini など）。
3. API キーを貼り付けます。
4. **Base URL** を確認します — ビルトインタイプには公式エンドポイントが事前入力されています。サードパーティのリレーやプロキシを使用する場合のみ変更してください。
::: tip
プロバイダーはいくつでも追加できます。各プロバイダーは独自の API キーとモデルのセットを個別に管理します。
:::
### 3. モデルを取得する
**モデルを取得**をクリックして、プロバイダーの API から利用可能なモデルのリストを取得します。必要に応じてモデル ID を手動で追加することもできます。
### 4. デフォルトモデルを設定する
**設定 → デフォルトモデル**に移動し、新しい会話でデフォルトとして使用するプロバイダーとモデルを選択します。
---
## 最初の会話
1. サイドバーの**新規チャット**をクリックします（または <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> を押します）。
2. チャット上部のモデルセレクターからモデルを選択します。
3. メッセージを入力して <kbd>Enter</kbd> を押します。
4. BoosApi はリアルタイムでレスポンスをストリーミングします。思考ブロックをサポートするモデル（Claude、DeepSeek R1 など）は、回答の上の折りたたみ可能なセクションに推論プロセスを表示します。
---
## 主要概念
### 会話ブランチ
任意のメッセージを編集または再生成してブランチを作成します。元のバージョンと新しいバージョンは同じ会話ツリーに共存します — 各メッセージの矢印コントロールでナビゲートできます。
### メッセージバージョン
再生成のたびに新しいバージョンが作成されます。メッセージバブルの **◀ ▶** 矢印でバージョンを切り替えられます。
### コンテキスト添付
ファイル、検索結果、MCP ツール出力を会話コンテキストに直接添付してプロンプトを充実させます。
---
## ショートカット
以下はデフォルトのキーボードショートカットです。すべてのショートカットは**設定 → ショートカット**でカスタマイズできます。
| ショートカット | アクション |
|--------------|-----------|
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>A</kbd> | 現在のウィンドウを表示/非表示 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>A</kbd> | すべてのウィンドウを表示/非表示 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>W</kbd> | ウィンドウを閉じる |
| <kbd>Cmd/Ctrl</kbd>+<kbd>N</kbd> | 新規会話 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>,</kbd> | 設定を開く |
| <kbd>Cmd/Ctrl</kbd>+<kbd>K</kbd> | コマンドパレット |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> | モデルセレクターを切り替え |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>↑</kbd> | 最後のメッセージを入力 |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>K</kbd> | コンテキストをクリア |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Backspace</kbd> | 会話メッセージをクリア |
| <kbd>Cmd/Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> | API ゲートウェイを切り替え |
::: info
グローバルショートカット（ウィンドウの表示/非表示）は、BoosApi がバックグラウンドにある場合でもシステム全体で動作します。BoosApi は他のアプリケーションのショートカットとの競合を検出し、設定で警告を表示します。
:::
---
## デスクトップ設定
**設定**を開いてデスクトップ体験を設定します。
| 設定 | オプション |
|------|---------|
| **テーマ** | ダーク、ライト、またはシステム（自動） |
| **言語** | 日本語、English、简体中文 |
| **システムトレイ** | トレイに最小化、トレイに閉じる |
| **自動起動** | コンピューター起動時に BoosApi を起動 |
| **常に最前面** | ウィンドウを他のアプリの上に保持 |
| **プロキシ** | ホストとポートを指定した HTTP または SOCKS5 プロキシ |
---
## データとバックアップ
### データディレクトリ
BoosApi は 2 つの場所にデータを保存します：
| パス | 内容 |
|------|------|
| `~/.boosapi/` | アプリケーション状態 — データベース、暗号化キー、ベクトル DB、SSL 証明書 |
| `~/Documents/boosapi/` | ユーザーが見えるファイル — 画像、ドキュメント、バックアップ |
::: tip
Windows では、パスは `%USERPROFILE%\.boosapi\` と `%USERPROFILE%\Documents\boosapi\` になります。
:::
### 自動バックアップ
**設定 → バックアップ**に移動して自動バックアップを設定します：
- **有効** — 自動バックアップのオン/オフを切り替え。
- **間隔** — バックアップの頻度（時間単位）。
- **最大数** — 最古のバックアップが削除される前に保持するバックアップ数。
- **ストレージターゲット** — ローカルディレクトリ（デフォルト：`~/Documents/boosapi/backups/`）または WebDAV サーバー。
### 手動バックアップと復元
バックアップ設定パネルからいつでも手動バックアップを作成できます。復元するには、履歴リストからバックアップを選択して**復元**をクリックします。
### 会話エクスポート
サイドバーの会話を右クリックしてエクスポートします：
- **PNG** — チャットのレンダリングスクリーンショット
- **Markdown** — ヘッダー、コードブロック、LaTeX 付きフォーマット
- **プレーンテキスト** — メッセージ区切りのシンプルなテキスト
- **JSON** — 完全なメタデータを含む構造化データ
---
## 次のステップ
- [プロバイダーの設定](./providers) — AI プロバイダーの追加と管理
- [MCP サーバー](./mcp) — AI 機能を拡張する外部ツールの接続
- [API ゲートウェイ](./gateway) — プロバイダーをローカル API サーバーとして公開
desktop/website/docs/ja/guide/mcp.md
+205
View File
@@ -0,0 +1,205 @@
# MCP サーバー
## MCP とは？
[Model Context Protocol（MCP）](https://modelcontextprotocol.io/)は、AI モデルが外部ツールやデータソースと対話できるようにするオープンスタンダードです。BoosApi は MCP クライアントとして機能します — MCP サーバーを追加すると、AI は会話中にそのサーバーが公開するツールを呼び出せます。
---
## トランスポートプロトコル
BoosApi は MCP サーバーとの通信に 3 つのトランスポートプロトコルをサポートしています：
| プロトコル | 接続 | ユースケース | 設定 |
|-----------|------|------------|------|
| **Stdio** | ローカルプロセス | `npx`、`uvx`、`python` などで起動するマシン上にインストールされたツール | `command` + `args` + オプション `env` |
| **SSE** | リモートサーバー | リモートマシンまたはクラウドサービスでホストされる Server-Sent Events エンドポイント | `url` |
| **StreamableHTTP** | リモートサーバー | HTTP ストリーミングエンドポイント（SSE の新しい代替） | `url` |
---
## MCP サーバーの追加
### フォームで作成
1. **設定 → MCP サーバー**に移動します。
2. **MCP サーバーを追加**をクリックします。
3. 名前を入力してトランスポートプロトコルを選択します。
4. 選択したプロトコルのフィールドを入力します：
- **Stdio** — 実行するコマンド、引数（JSON 配列）、環境変数（JSON オブジェクト）、タイムアウト。
- **SSE** — エンドポイント URL、タイムアウト。
- **StreamableHTTP** — エンドポイント URL、タイムアウト。
5. **保存**をクリックします。
### JSON インポート
**JSON インポート**をクリックして設定オブジェクトを貼り付けます。BoosApi は標準の MCP JSON 形式を受け入れます：
#### Stdio サーバー
```json
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
```
#### SSE サーバー
```json
{
"mcpServers": {
"remote-tools": {
"type": "sse",
"url": "https://example.com/sse"
}
}
}
```
#### StreamableHTTP サーバー
```json
{
"mcpServers": {
"remote-http": {
"type": "streamablehttp",
"url": "https://example.com/mcp"
}
}
}
```
#### 複数のサーバーを一度に
```json
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
},
"filesystem": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/me/projects"]
},
"remote": {
"type": "sse",
"url": "https://example.com/sse"
}
}
}
```
---
## 設定例
### ウェブフェッチ — `mcp-server-fetch`
ウェブページを取得して AI のために読みやすいテキストに変換します。
```json
{
"mcpServers": {
"fetch": {
"command": "uvx",
"args": ["mcp-server-fetch"]
}
}
}
```
### ファイル操作 — `@modelcontextprotocol/server-filesystem`
AI にマシン上の特定のディレクトリへの読み書きアクセスを与えます。
```json
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"/Users/me/documents",
"/Users/me/projects"
]
}
}
}
```
### リモート SSE サーバー
Server-Sent Events を介してリモートツールサーバーに接続します。
```json
{
"mcpServers": {
"cloud-tools": {
"type": "sse",
"url": "https://mcp.example.com/sse"
}
}
}
```
### 環境変数付き Stdio
環境変数を介して API キーや設定をサーバープロセスに渡します。
```json
{
"mcpServers": {
"weather": {
"command": "python",
"args": ["-m", "weather_server"],
"env": {
"WEATHER_API_KEY": "your-api-key"
}
}
}
}
```
---
## ビルトインツール
BoosApi には、外部 MCP サーバーを追加せずに使用できるビルトインツールが付属しています：
| ツール | 説明 |
|--------|------|
| **@boosapi/fetch** | ウェブページと HTTP リソースの取得 |
| **@boosapi/search-file** | ローカルファイルシステムでのファイル検索 |
ビルトインツールは、カスタムサーバーと並んで MCP サーバー設定に一覧表示され、個別に有効化・無効化できます。
---
## ツール実行パネル
AI が会話中に MCP ツールを呼び出すと、BoosApi はチャット内にインラインで**ツール実行パネル**を表示します。パネルには以下が表示されます：
- **ツール名**とそれが属する**サーバー**。
- ツールに送信された**入力引数**。
- ツールによって返された**出力**。
- 実行ステータス（実行中、成功、または失敗）。
会話内の任意のツール呼び出しをクリックして詳細を展開します。これにより、AI が何をしたかを確認し、予期しない結果をデバッグするのが簡単になります。
---
## ツールループ上限
Settings -> MCP で、MCP 対応応答が連続して実行できるツール呼び出し回数の上限を設定できます。未知のサーバーを試すときは低めに、複数ツールを意図的に連鎖させるワークフローでは高めに設定できます。
## 次のステップ
- [API ゲートウェイ](./gateway) — プロバイダーをローカル API サーバーとして公開
- [クイックスタート](./getting-started) — クイックスタートガイドに戻る
desktop/website/docs/ja/guide/providers.md
+207
View File
@@ -0,0 +1,207 @@
# プロバイダーの設定
BoosApi は任意の数の AI プロバイダーに同時に接続できます。各プロバイダーには独自の API キー、モデルリスト、パラメーターのデフォルトがあります。
## サポートされているプロバイダー
BoosApi は以下のプロバイダーをファーストクラスでサポートしています。OpenAI 互換 API を公開するサービスはすべてそのまま動作します。
| プロバイダー | モデル例 |
|------------|---------|
| **OpenAI** | GPT-4o、GPT-4、o3、o4-mini |
| **Anthropic** | Claude 4 Sonnet、Claude 4 Opus、Claude 3.5 Sonnet |
| **Google** | Gemini 2.5 Pro、Gemini 2.5 Flash、Gemini 2.0 |
| **DeepSeek** | DeepSeek V3、DeepSeek R1 |
| **Alibaba Cloud** | Qwen シリーズ |
| **Zhipu AI** | GLM シリーズ |
| **xAI** | Grok シリーズ |
| **OpenAI 互換 API** | Ollama、vLLM、LiteLLM、サードパーティリレーなど |
---
## プロバイダーの追加
1. **設定 → プロバイダー**に移動します。
2. 左下の **+** ボタンをクリックします。
3. プロバイダーの詳細を入力します：
| フィールド | 説明 |
|-----------|------|
| **名前** | サイドバーの表示名（例：*OpenAI*） |
| **タイプ** | プロバイダータイプ — デフォルトの Base URL と API 動作を決定 |
| **アイコン** | 視覚的識別のためのオプションアイコン |
| **API キー** | プロバイダーのダッシュボードからのシークレットキー |
| **Base URL** | API エンドポイント（ビルトインタイプには事前入力、リレー用に変更可能） |
| **API パス** | リクエストパス — デフォルトは `/v1/chat/completions` |
::: tip
サードパーティのリレーサービスの場合、タイプを **OpenAI**（または対応するアップストリームタイプ）に設定し、**Base URL** をリレーのエンドポイントに変更します。
:::
---
## Web サイトのリンクからインポート
プロバイダーの Web サイト、リレーサービスのダッシュボード、プライベートモデル基盤、ローカルゲートウェイの管理画面は、**BoosApi で開く** リンクを提供できます。ユーザーがクリックするとブラウザーが BoosApi デスクトップアプリを起動し、BoosApi は **設定 → プロバイダー** に移動して確認ダイアログを表示します。インポートはユーザーが確認した後にのみ実行されます。
### ユーザーフロー
1. プロバイダーリンクのインポートに対応した BoosApi をインストールして開きます。
2. ブラウザーでプロバイダーが提供する **BoosApi で開く** リンクをクリックします。
3. BoosApi の確認ダイアログで、プロバイダー名、Base URL、タイプ、API キーのプレフィックスを確認します。
4. BoosApi は同じ **Base URL + タイプ** の既存プロバイダーを再利用します。存在しない場合は新規作成し、API キーがまだ存在しない場合のみ追加します。
BoosApi は API キーの検証やモデル取得を自動では行いません。インポート後に **モデルを取得** をクリックするか、モデル ID を手動で追加してください。
### リンク形式
```text
boosapi://providers?name=<name>&baseurl=<base-url>&apikey=<api-key>&type=<provider-type>
```
例：
```text
boosapi://providers?name=OpenAI&baseurl=https%3A%2F%2Fapi.openai.com&apikey=sk-xxx&type=openai
```
### パラメーター
| パラメーター | 必須 | 説明 |
|-------------|------|------|
| `name` | はい | BoosApi に表示する名前。例：`OpenAI`、`My Relay` |
| `baseurl` | はい | URL エンコード済みの Base URL。`http` / `https` のみ有効で、query や hash は拒否されます。 |
| `apikey` | はい | BoosApi に保存する API キー。確認ダイアログにはプレフィックスのみ表示されます。 |
| `type` | はい | プロバイダータイプ。指定可能な値：`openai`、`openai_responses`、`anthropic`、`gemini`、`custom`。 |
`baseurl` では BoosApi 既存の強制サフィックスも使用できます（例：`https://example.com!`）。リンク経由のインポートでは `api_path` は設定されず、選択したプロバイダータイプのデフォルトパスが使われます。
### Web サイト側の設定
すべての動的値は `encodeURIComponent` または `URLSearchParams` でエンコードしてください：
```html
<a id="open-boosapi" href="#">BoosApi で開く</a>
<script>
const provider = {
name: 'My Relay',
baseurl: 'https://api.example.com',
apikey: 'sk-user-key',
type: 'openai',
};
const params = new URLSearchParams({
name: provider.name,
baseurl: provider.baseurl,
apikey: provider.apikey,
type: provider.type,
});
document.getElementById('open-boosapi').href = `boosapi://providers?${params.toString()}`;
</script>
```
API キーをオンラインで生成できるサービスでは、ユーザーがログインし、明示的にキーを選択または作成した後にのみリンクを生成することを推奨します。
::: warning セキュリティ
URL 内の API キーは、ブラウザー履歴、ログ、拡張機能、解析スクリプトに記録される可能性があります。実際のキーを公開ページ、静的 HTML、第三者のリダイレクト URL に置かないでください。ユーザー専用のアカウントページで、確認後に生成する方法を推奨します。
:::
::: tip テスト
`boosapi://` はインストール済みデスクトップアプリがシステムに登録するカスタムプロトコルです。Web サイトや Vite 開発サーバーを実行するだけでは登録されません。クリックしても BoosApi が開かない場合は、まず最新の BoosApi デスクトップアプリをインストールまたは再ビルドしてください。
:::
---
## CC Switch からインポート
Settings -> Providers で CC Switch のプロバイダー設定をスキャンできます。候補を確認し、インポート可能な行を選ぶと、プロバイダー、Base URL、API Key、モデルリストを BoosApi に取り込めます。OAuth のみ、または再利用できるキーがない項目は理由付きでスキップされます。
## 高度なモデルリクエストボディ
各モデルには extra_body を設定できます。これは OpenAI 互換 Chat Completions のリクエストへ平坦化して追加される JSON オブジェクトです。enable_thinking などのベンダー固有オプションに使えます。BoosApi は JSON を検証し、model、messages、stream、tools、基本サンプリング項目の上書きを防ぎます。
## マルチキーローテーション
BoosApi はロード分散とレート制限回避のために、プロバイダーごとに複数の API キーをサポートします。
### キーの追加
プロバイダー詳細パネルで**キーを追加**をクリックして、追加の API キーを追加します。各キーには、プレフィックス、作成日、最終使用タイムスタンプが表示されます。
### ローテーションの仕組み
BoosApi はラウンドロビンインデックスを使用して有効なキーを自動的にローテーションします。リクエストが完了すると、ローテーションインデックスが次のキーに進みます。キーが無効化されたり検証に失敗した場合はスキップされます。
### キーの検証
キーの隣の**検証**ボタンをクリックして、プロバイダーの API に対して検証します。検証結果とエラーメッセージが記録されます。
---
## モデル管理
### モデルの取得
プロバイダー詳細パネルで**モデルを取得**をクリックして、プロバイダーの API から利用可能なモデルの完全なリストを取得します。発見されたモデルは自動的にローカルリストに追加されます。
### モデルの手動追加
API によって返されないモデル（例：ファインチューニングされたモデルや新しいリリース）は、モデル ID を直接入力して追加できます。
### モデルごとのパラメーター
各モデルに独自のデフォルトパラメーターオーバーライドを設定できます：
| パラメーター | 説明 |
|------------|------|
| **温度** | ランダム性を制御（0 = 決定論的、高いほどよりクリエイティブ） |
| **最大トークン数** | レスポンスの最大トークン数 |
| **Top P** | 核サンプリングのしきい値 |
| **頻度ペナルティ** | トークンシーケンスの繰り返しを減少 |
| **存在ペナルティ** | モデルが新しいトピックを導入するよう促す |
### モデル能力
BoosApi はモデルごとに能力（**ビジョン**、**関数呼び出し**、**推論**など）を追跡し、タグとして表示します。これらの能力は会話中に利用できる機能に影響します。
---
## カスタム & ローカルエンドポイント
BoosApi は OpenAI チャットコンプリーション API を実装するエンドポイントであれば何でも動作します。
### Ollama（ローカルモデル）
1. [Ollama](https://ollama.com/) をインストールして起動します。
2. BoosApi でタイプ **OpenAI** の新しいプロバイダーを作成します。
3. **Base URL** を `http://localhost:11434` に設定します。
4. **モデルを取得**をクリックして、ローカルにプルされたモデルを発見します。
### vLLM / TGI
推論サーバーのアドレス（例：`http://localhost:8000`）に **Base URL** を設定し、通常通りモデルを取得または追加します。
### API リレーサービス
リレーまたはアグリゲーターサービス（例：OpenRouter、one-api）の場合、タイプを **OpenAI** に設定し、リレーの Base URL を入力し、リレーの API キーを提供します。
---
## デフォルトモデル設定
### デフォルトアシスタントモデル
**設定 → デフォルトモデル**に移動して、新しい会話でデフォルトとして使用するプロバイダーとモデルを選択します。モデルセレクターから会話ごとに常にモデルをオーバーライドできます。
### トピック命名モデル
BoosApi は各会話のタイトルを自動的に生成できます。デフォルトモデル設定で、タイトル生成のコストとレイテンシーを節約するために、トピック命名専用の軽量モデルを割り当てられます。タイトル生成用のカスタムプロンプトとコンテキストウィンドウサイズを設定できます。
---
## 次のステップ
- [MCP サーバー](./mcp) — AI 機能を拡張する外部ツールの接続
- [API ゲートウェイ](./gateway) — プロバイダーをローカル API サーバーとして公開
desktop/website/docs/ja/index.md
+57
View File
@@ -0,0 +1,57 @@
---
layout: home
title: "BoosApi — オープンソース AI デスクトップクライアント & ゲートウェイ"
titleTemplate: false
head:
- - meta
- name: description
content: "BoosApi は無料のオープンソース AI デスクトップクライアントです。マルチモデルチャット、Agent、MCP、ChatGPT/Cherry Studio/Kelivo インポート、ローカル RAG、S3/WebDAV バックアップ、内蔵 AI ゲートウェイをサポートします。"
hero:
name: BoosApi
text: "AI デスクトップワークスペース"
tagline: "マルチモデルチャット、Agent、MCP ツール、API ゲートウェイ、インポート、ナレッジベース、バックアップを 1 つのローカルファーストクライアントに統合"
image:
src: /logo.png
alt: BoosApi
actions:
- theme: brand
text: "クイックスタート"
link: /ja/guide/getting-started
- theme: alt
text: "ダウンロード"
link: /ja/download
- theme: alt
text: GitHub
link: https://github.com/BoosApi-Desktop/BoosApi
features:
- icon: robot
title: "マルチモデルチャット"
details: "OpenAI、Claude、Gemini、DeepSeek、Qwen と互換 API。キーローテーション、分岐、圧縮、複数モデル回答に対応。"
- icon: api
title: "プロバイダー設定"
details: "boosapi:// リンク、CC Switch インポート、カスタムヘッダー、プロキシ、OpenAI Responses、モデル別 extra_body。"
- icon: thunderbolt
title: "AI Agent"
details: "ファイル編集、コマンド実行、コード分析を権限制御、作業ディレクトリサンドボックス、承認 UI、コスト追跡付きで実行。"
- icon: edit
title: "リッチレンダリング"
details: "Markdown、LaTeX、Mermaid、D2、Monaco、HTML フラグメント、Artifact プレビュー。"
- icon: search
title: "検索と RAG"
details: "引用付き Web 検索、クエリ生成、ローカル sqlite-vec ナレッジベース、リランク設定、取得フィードバック。"
- icon: cloud-server
title: "API ゲートウェイ"
details: "OpenAI 互換、OpenAI Responses、Claude、Gemini のローカル API を Claude Code、Codex、OpenCode などに提供。"
- icon: book
title: "データインポート"
details: "ChatGPT 公式エクスポート、Cherry Studio、Kelivo バックアップを重複処理と任意のプロバイダー移行付きで取り込み。"
- icon: lock
title: "バックアップと安全性"
details: "AES-256 ローカル暗号化、二重ルートデータ配置、ローカル/WebDAV/S3 バックアップと復元。"
- icon: desktop
title: "デスクトップ体験"
details: "11 言語 UI、トレイ、常に手前、グローバルショートカット、自動起動、プロキシ、自動更新。"
---