GUI / Headless / MCP モードを使う¶
Koharu は通常のデスクトップアプリとしても、Web UI 付きの headless ローカルサーバーとしても、AI エージェント向け MCP サーバーとしても動作します。これらは別々のバックエンドではなく、どれも同じローカルランタイムと HTTP サーバーの上に乗っています。
モードが違っても変わらないこと¶
どの起動方法でも、ランタイムの基本形は同じです。
- サーバーは
127.0.0.1にバインドされる - UI と API は同じローカルプロセスから配信される
- ページパイプライン、モデル読み込み、書き出しは同じ内部コード経路を使う
そのため、デスクトップ編集、headless 自動化、MCP ツールが挙動としてズレにくくなっています。
モード一覧¶
| モード | デスクトップウィンドウ | ローカルサーバー | 主な用途 |
|---|---|---|---|
| Desktop | yes | yes | 通常の対話編集 |
| Headless | no | yes | ローカル Web UI、スクリプト、自動化 |
| MCP | optional | yes | /mcp 経由のエージェント連携 |
デスクトップアプリとして使う¶
インストールしたアプリを通常どおり起動します。
デスクトップモードでも、Koharu は内部でローカル HTTP サーバーを起動します。埋め込みウィンドウはパイプラインを直接呼ぶのではなく、このローカルサーバーと通信します。
これは既定モードであり、ほとんどのユーザーにはこの使い方が最適です。
headless モードで使う¶
headless モードでは、デスクトップ GUI を開かずにローカルサーバーだけを起動します。
# macOS / Linux
koharu --port 4000 --headless
# Windows
koharu.exe --port 4000 --headless
起動後、Web UI は http://localhost:4000 で開けます。
headless モードは停止するまで前面で実行され続け、通常は Ctrl+C で終了します。
固定ポートで起動する¶
既定では、Koharu はランダムなローカルポートを使います。ブックマーク、スクリプト、リバースプロキシ、MCP クライアントなどで安定したアドレスが必要なら --port を使ってください。
# macOS / Linux
koharu --port 9999
# Windows
koharu.exe --port 9999
--port を指定しなくてもサーバー自体は起動しますが、使用ポートは毎回変わります。
ローカル API に接続する¶
固定ポートで起動した場合、主なエンドポイントは次の通りです。
- Web UI:
http://localhost:9999/ - RPC / HTTP API:
http://localhost:9999/api/v1 - MCP サーバー:
http://localhost:9999/mcp
9999 は選んだポート番号に置き換えてください。
Koharu は loopback にバインドされるため、これらのエンドポイントは既定ではローカル専用です。別マシンからアクセスしたい場合は、自分でそのポートを公開する必要があります。
エンドポイントごとの詳細は HTTP API リファレンス を参照してください。
MCP サーバーに接続する¶
Koharu には、アプリ本体と同じドキュメント、モデル、ページパイプラインを共有する組み込み MCP サーバーがあります。
MCP クライアントやエージェントは次に向けます。
http://localhost:9999/mcp
これは、エージェントに次のような作業をさせたいときに便利です。
- テキストブロックの確認
- OCR や翻訳の実行
- rendered ページの書き出し
- レビューやバッチ処理の自動化
クライアントごとの設定例は MCP クライアントを設定する を参照してください。
組み込みツール一覧そのものは MCP ツールリファレンス にあります。
CPU モードを強制する¶
GPU 推論を明示的に無効にしたい場合は --cpu を使います。
# macOS / Linux
koharu --cpu
# Windows
koharu.exe --cpu
これは互換性確認、ドライバ問題の切り分け、GPU 周りが不確かなときの低リスクなデバッグに向いています。
ランタイム依存物だけをダウンロードする¶
アプリを起動せず、ランタイム依存物だけを事前取得したい場合は --download を使います。
# macOS / Linux
koharu --download
# Windows
koharu.exe --download
現在の実装では、この経路で初期化されるのは次です。
- ローカル推論スタックで使うランタイムライブラリ
- 既定の vision / OCR モデル群
オプションのローカル翻訳 LLM までは事前取得されません。それらは設定で選んだ時点でダウンロードされます。
デバッグ出力を有効にする¶
ログ付きでコンソール中心の起動をしたい場合は --debug を使います。
# macOS / Linux
koharu --debug
# Windows
koharu.exe --debug
Windows では、debug 実行と headless 実行の組み合わせにより、Koharu がコンソールウィンドウにアタッチするか、新しく作るかが変わります。