diff options
| author | Adam <[email protected]> | 2026-02-11 18:51:27 -0600 |
|---|---|---|
| committer | Adam <[email protected]> | 2026-02-11 18:51:50 -0600 |
| commit | aea68c386a4f64cf718c3eeee9dffec8409ee6b0 (patch) | |
| tree | bdf06cb3372c6c48c97c43b41e53e514888a52b3 /packages/web/src/content/docs/ja/server.mdx | |
| parent | 8eea53a41e92257d1a4ad6653d0d2930465bf34a (diff) | |
| download | opencode-aea68c386a4f64cf718c3eeee9dffec8409ee6b0.tar.gz opencode-aea68c386a4f64cf718c3eeee9dffec8409ee6b0.zip | |
fix(docs): locale translations for nav elements and headings
Diffstat (limited to 'packages/web/src/content/docs/ja/server.mdx')
| -rw-r--r-- | packages/web/src/content/docs/ja/server.mdx | 284 |
1 files changed, 140 insertions, 144 deletions
diff --git a/packages/web/src/content/docs/ja/server.mdx b/packages/web/src/content/docs/ja/server.mdx index e86e81197..cbea87083 100644 --- a/packages/web/src/content/docs/ja/server.mdx +++ b/packages/web/src/content/docs/ja/server.mdx @@ -1,12 +1,12 @@ --- -title: サーバ -description: HTTP 経由でopencode サーバーと通信します。 +title: サーバー +description: HTTP 経由で OpenCode サーバーと通信します。 --- import config from "../../../../config.mjs" export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts` -`opencode serve` コマンドは、opencode クライアントが使用できる OpenAPI エンドポイントを公開するヘッドレス HTTP サーバーを実行します。 +`opencode serve` コマンドは、OpenCode クライアントが使用できる OpenAPI エンドポイントを公開するヘッドレス HTTP サーバーを実行します。 --- @@ -18,13 +18,13 @@ opencode serve [--port <number>] [--hostname <string>] [--cors <origin>] #### オプション -| 旗 | 説明 | デフォルト | -| --------------- | ---------------------------------- | ---------------- | -| `--port` | リッスンするポート | `4096` | -| `--hostname` | リッスンするホスト名 | `127.0.0.1` | -| `--mdns` | mDNS 検出を有効にする | `false` | -| `--mdns-domain` | mDNS サービスのカスタム ドメイン名 | `opencode.local` | -| `--cors` | 許可する追加のブラウザーオリジン | `[]` | +| フラグ | 説明 | デフォルト | +| --------------- | --------------------------------- | ---------------- | +| `--port` | リッスンするポート | `4096` | +| `--hostname` | リッスンするホスト名 | `127.0.0.1` | +| `--mdns` | mDNS 検出を有効にする | `false` | +| `--mdns-domain` | mDNS サービスのカスタムドメイン名 | `opencode.local` | +| `--cors` | 許可する追加のブラウザーオリジン | `[]` | `--cors` は複数回渡すことができます。 @@ -46,29 +46,25 @@ OPENCODE_SERVER_PASSWORD=your-password opencode serve ### 仕組み -`opencode` を実行すると、TUI とサーバーが起動します。 TUI の場所 -サーバーと通信するクライアント。サーバーは OpenAPI 3.1 仕様を公開します -終点。このエンドポイントは、[SDK](/docs/sdk). +`opencode` を実行すると、TUI とサーバーが起動します。 TUI はサーバーと通信するクライアントです。サーバーは OpenAPI 3.1 仕様のエンドポイントを公開します。このエンドポイントは、[SDK](/docs/sdk) を使用してアクセスできます。 :::tip -opencode サーバーを使用して、プログラムで opencode と対話します。 +OpenCode サーバーを使用して、プログラムで OpenCode と対話します。 ::: -This -`opencode serve` を実行してスタンドアロン サーバーを起動できます。持っている場合は、 -opencode TUI を実行すると、`opencode serve` が新しいサーバーを起動します。 +`opencode serve` を実行してスタンドアロンサーバーを起動できます。すでに OpenCode TUI を実行している場合でも、`opencode serve` は新しいサーバーを起動します。 --- #### 既存のサーバーに接続する -TUI を起動すると、ポートとホスト名がランダムに割り当てられます。代わりに、`--hostname` と `--port` [flags](/docs/cli).次に、これを使用してサーバーに接続します。 +TUI を起動すると、ポートとホスト名がランダムに割り当てられます。代わりに、`--hostname` と `--port` [フラグ](/docs/cli) を使用して固定できます。次に、これを使用してサーバーに接続します。 -[`/tui`](#tui) エンドポイントは、サーバー経由で TUI を駆動するために使用できます。たとえば、プロンプトを事前入力したり、実行したりできます。この設定は、OpenCode [IDE](/docs/ide) プラグイン] によって使用されます。 +[`/tui`](#tui) エンドポイントは、サーバー経由で TUI を駆動するために使用できます。たとえば、プロンプトを事前入力したり、実行したりできます。この設定は、OpenCode [IDE](/docs/ide) プラグインによって使用されます。 --- -## スペック +## 仕様 サーバーは、次の場所で閲覧できる OpenAPI 3.1 仕様を公開しています。 @@ -82,205 +78,205 @@ http://<hostname>:<port>/doc ## API -opencode サーバーは次の API を公開します。 +OpenCode サーバーは次の API を公開します。 --- -### グローバル +### Global -| 方法 | パス | 説明 | 応答 | -| ----- | ---------------- | ------------------------------------------ | ------------------------------------ | -| `GET` | `/global/health` | サーバーの健全性とバージョンを取得する | `{ healthy: true, version: string }` | -| `GET` | `/global/event` | グローバル イベントの取得 (SSE ストリーム) | イベントストリーム | +| メソッド | パス | 説明 | レスポンス | +| -------- | ---------------- | ----------------------------------------- | ------------------------------------ | +| `GET` | `/global/health` | サーバーの健全性とバージョンを取得する | `{ healthy: true, version: string }` | +| `GET` | `/global/event` | グローバルイベントの取得 (SSE ストリーム) | イベントストリーム | --- -### プロジェクト +### Project -| 方法 | パス | 説明 | 応答 | -| ----- | ------------------ | -------------------------------- | -------------------------------------------------- | -| `GET` | `/project` | すべてのプロジェクトをリストする | <a href={typesUrl}><code>プロジェクト[]</code></a> | -| `GET` | `/project/current` | 現在のプロジェクトを取得 | <a href={typesUrl}><code>プロジェクト</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------------ | -------------------------------- | --------------------------------------------- | +| `GET` | `/project` | すべてのプロジェクトをリストする | <a href={typesUrl}><code>Project[]</code></a> | +| `GET` | `/project/current` | 現在のプロジェクトを取得 | <a href={typesUrl}><code>Project</code></a> | --- -### パスと VCS +### Path and VCS -| 方法 | パス | 説明 | 応答 | -| ----- | ------- | --------------------------------------- | ------------------------------------------- | -| `GET` | `/path` | 現在のパスを取得する | <a href={typesUrl}><code>パス</code></a> | -| `GET` | `/vcs` | 現在のプロジェクトの VCS 情報を取得する | <a href={typesUrl}><code>VcsInfo</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------- | --------------------------------------- | ------------------------------------------- | +| `GET` | `/path` | 現在のパスを取得する | <a href={typesUrl}><code>Path</code></a> | +| `GET` | `/vcs` | 現在のプロジェクトの VCS 情報を取得する | <a href={typesUrl}><code>VcsInfo</code></a> | --- -### 実例 +### Instance -| 方法 | パス | 説明 | 応答 | -| ------ | ------------------- | ---------------------------- | ------ | -| `POST` | `/instance/dispose` | 現在のインスタンスを破棄する | うーん | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------------- | ---------------------------- | ---------- | +| `POST` | `/instance/dispose` | 現在のインスタンスを破棄する | void | --- -### 構成 +### Config -| 方法 | パス | 説明 | 応答 | -| ------- | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | -| `GET` | `/config` | 構成情報を取得する | <a href={typesUrl}><code>構成</code></a> | -| `PATCH` | `/config` | 構成を更新する | <a href={typesUrl}><code>構成</code></a> | -| `GET` | `/config/providers` | プロバイダーとデフォルトのモデルをリストする | `{ providers: `<a href={typesUrl}>プロバイダ[]</a>`, default: { [key: string]: string } }` | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `GET` | `/config` | 設定情報を取得する | <a href={typesUrl}><code>Config</code></a> | +| `PATCH` | `/config` | 設定を更新する | <a href={typesUrl}><code>Config</code></a> | +| `GET` | `/config/providers` | プロバイダーとデフォルトのモデルをリストする | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` | --- ### プロバイダー -| 方法 | パス | 説明 | 応答 | -| ------ | -------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------- | -| `GET` | `/provider` | すべてのプロバイダーをリストする | `{ all: `<a href={typesUrl}>プロバイダ[]</a>`, default: {...}, connected: string[] }` | -| `GET` | `/provider/auth` | プロバイダーの認証方法を取得する | `{ [providerID: string]: `<a href={typesUrl}>ProviderAuthMethod[]</a>` }` | -| `POST` | `/provider/{id}/oauth/authorize` | OAuth を使用してプロバイダーを認証する | <a href={typesUrl}><code>ProviderAuthAuthorization</code></a> | -| `POST` | `/provider/{id}/oauth/callback` | プロバイダーの OAuth コールバックを処理する | うーん | +| メソッド | パス | 説明 | レスポンス | +| -------- | -------------------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| `GET` | `/provider` | すべてのプロバイダーをリストする | `{ all: `<a href={typesUrl}><code>Provider[]</code></a>`, default: {...}, connected: string[] }` | +| `GET` | `/provider/auth` | プロバイダーの認証方法を取得する | `{ [providerID: string]: `<a href={typesUrl}><code>ProviderAuthMethod[]</code></a>` }` | +| `POST` | `/provider/{id}/oauth/authorize` | OAuth を使用してプロバイダーを認証する | <a href={typesUrl}><code>ProviderAuthAuthorization</code></a> | +| `POST` | `/provider/{id}/oauth/callback` | プロバイダーの OAuth コールバックを処理する | void | --- -### セッション - -| 方法 | パス | 説明 | メモ | -| -------- | ---------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| `GET` | `/session` | すべてのセッションをリストする | 戻り値 <a href={typesUrl}><code>セッション[]</code></a> | -| `POST` | `/session` | 新しいセッションを作成する | 本文: `{ parentID?, title? }`、<a href={typesUrl}><code>セッション</code></a> を返します。 | -| `GET` | `/session/status` | すべてのセッションのセッション ステータスを取得する | 戻り値 `{ [sessionID: string]: `<a href={typesUrl}>SessionStatus</a>` }` | -| `GET` | `/session/:id` | セッションの詳細を取得する | 戻り値 <a href={typesUrl}><code>セッション</code></a> | -| `DELETE` | `/session/:id` | セッションとそのすべてのデータを削除する | 戻り値 `boolean` | -| `PATCH` | `/session/:id` | セッションのプロパティを更新する | 本文: `{ title? }`、<a href={typesUrl}><code>セッション</code></a> を返します。 | -| `GET` | `/session/:id/children` | セッションの子セッションを取得する | 戻り値 <a href={typesUrl}><code>セッション[]</code></a> | -| `GET` | `/session/:id/todo` | セッションの ToDo リストを取得する | 戻り値 <a href={typesUrl}><code>Todo[]</code></a> | -| `POST` | `/session/:id/init` | アプリを分析して `AGENTS.md` を作成する | 本文: `{ messageID, providerID, modelID }`、`boolean` を返します。 | -| `POST` | `/session/:id/fork` | メッセージで既存のセッションをフォークする | 本文: `{ messageID? }`、<a href={typesUrl}><code>セッション</code></a> を返します。 | -| `POST` | `/session/:id/abort` | 実行中のセッションを中止する | 戻り値 `boolean` | -| `POST` | `/session/:id/share` | セッションを共有する | 戻り値 <a href={typesUrl}><code>セッション</code></a> | -| `DELETE` | `/session/:id/share` | セッションの共有を解除する | 戻り値 <a href={typesUrl}><code>セッション</code></a> | -| `GET` | `/session/:id/diff` | このセッションの差分を取得する | クエリ: `messageID?`、<a href={typesUrl}><code>FileDiff[]</code></a> を返します。 | -| `POST` | `/session/:id/summarize` | セッションを要約する | 本文: `{ providerID, modelID }`、`boolean` を返します。 | -| `POST` | `/session/:id/revert` | メッセージを元に戻す | 本文: `{ messageID, partID? }`、`boolean` を返します。 | -| `POST` | `/session/:id/unrevert` | 元に戻したすべてのメッセージを復元する | 戻り値 `boolean` | -| `POST` | `/session/:id/permissions/:permissionID` | 許可リクエストに応答する | 本文: `{ response, remember? }`、`boolean` を返します。 | +### Session + +| メソッド | パス | 説明 | 詳細 | +| -------- | ---------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `GET` | `/session` | すべてのセッションをリストする | 戻り値 <a href={typesUrl}><code>Session[]</code></a> | +| `POST` | `/session` | 新しいセッションを作成する | 本文: `{ parentID?, title? }`、<a href={typesUrl}><code>Session</code></a> を返します。 | +| `GET` | `/session/status` | すべてのセッションのセッションステータスを取得する | 戻り値 `{ [sessionID: string]: `<a href={typesUrl}><code>SessionStatus</code></a>` }` | +| `GET` | `/session/:id` | セッションの詳細を取得する | 戻り値 <a href={typesUrl}><code>Session</code></a> | +| `DELETE` | `/session/:id` | セッションとそのすべてのデータを削除する | 戻り値 `boolean` | +| `PATCH` | `/session/:id` | セッションのプロパティを更新する | 本文: `{ title? }`、<a href={typesUrl}><code>Session</code></a> を返します。 | +| `GET` | `/session/:id/children` | セッションの子セッションを取得する | 戻り値 <a href={typesUrl}><code>Session[]</code></a> | +| `GET` | `/session/:id/todo` | セッションの ToDo リストを取得する | 戻り値 <a href={typesUrl}><code>Todo[]</code></a> | +| `POST` | `/session/:id/init` | アプリを分析して `AGENTS.md` を作成する | 本文: `{ messageID, providerID, modelID }`、`boolean` を返します。 | +| `POST` | `/session/:id/fork` | メッセージで既存のセッションをフォークする | 本文: `{ messageID? }`、<a href={typesUrl}><code>Session</code></a> を返します。 | +| `POST` | `/session/:id/abort` | 実行中のセッションを中止する | 戻り値 `boolean` | +| `POST` | `/session/:id/share` | セッションを共有する | 戻り値 <a href={typesUrl}><code>Session</code></a> | +| `DELETE` | `/session/:id/share` | セッションの共有を解除する | 戻り値 <a href={typesUrl}><code>Session</code></a> | +| `GET` | `/session/:id/diff` | このセッションの差分を取得する | クエリ: `messageID?`、<a href={typesUrl}><code>FileDiff[]</code></a> を返します。 | +| `POST` | `/session/:id/summarize` | セッションを要約する | 本文: `{ providerID, modelID }`、`boolean` を返します。 | +| `POST` | `/session/:id/revert` | メッセージを元に戻す | 本文: `{ messageID, partID? }`、`boolean` を返します。 | +| `POST` | `/session/:id/unrevert` | 元に戻したすべてのメッセージを復元する | 戻り値 `boolean` | +| `POST` | `/session/:id/permissions/:permissionID` | 許可リクエストに応答する | 本文: `{ response, remember? }`、`boolean` を返します。 | --- -### メッセージ +### Message -| 方法 | パス | 説明 | メモ | -| ------ | --------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `GET` | `/session/:id/message` | セッション内のメッセージをリストする | クエリ: `limit?`、`{ info: `<a href={typesUrl}>メッセージ</a>を返します。`, parts: `<a href={typesUrl}>Part[]</a>`}[]` | -| `POST` | `/session/:id/message` | メッセージを送信して応答を待ちます | 本文: `{ messageID?, model?, agent?, noReply?, system?, tools?, parts }`、`{ info: `<a href={typesUrl}>メッセージ</a>を返します`, parts: `<a href={typesUrl}>Part[]</a>`}` | -| `GET` | `/session/:id/message/:messageID` | メッセージの詳細を取得する | 戻り値 `{ info: `<a href={typesUrl}>メッセージ</a>`, parts: `<a href={typesUrl}>Part[]</a>`}` | -| `POST` | `/session/:id/prompt_async` | メッセージを非同期に送信する (待機なし) | body: `/session/:id/message` と同じ、`204 No Content` を返します。 | -| `POST` | `/session/:id/command` | スラッシュコマンドを実行します | 本文: `{ messageID?, agent?, model?, command, arguments }`、`{ info: `<a href={typesUrl}>メッセージ</a>を返します`, parts: `<a href={typesUrl}>Part[]</a>`}` | -| `POST` | `/session/:id/shell` | shell コマンドを実行する | 本文: `{ agent, model?, command }`、`{ info: `<a href={typesUrl}>メッセージ</a>を返します`, parts: `<a href={typesUrl}>Part[]</a>`}` | +| メソッド | パス | 説明 | 詳細 | +| -------- | --------------------------------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `GET` | `/session/:id/message` | セッション内のメッセージをリストする | クエリ: `limit?`、`{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` を返します。 | +| `POST` | `/session/:id/message` | メッセージを送信して応答を待ちます | 本文: `{ messageID?, model?, agent?, noReply?, system?, tools?, parts }`、`{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` を返します | +| `GET` | `/session/:id/message/:messageID` | メッセージの詳細を取得する | 戻り値 `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` | +| `POST` | `/session/:id/prompt_async` | メッセージを非同期に送信する (待機なし) | body: `/session/:id/message` と同じ、`204 No Content` を返します。 | +| `POST` | `/session/:id/command` | スラッシュコマンドを実行します | 本文: `{ messageID?, agent?, model?, command, arguments }`、`{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` を返します | +| `POST` | `/session/:id/shell` | シェルコマンドを実行する | 本文: `{ agent, model?, command }`、`{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` を返します | --- -### コマンド +### Command -| 方法 | パス | 説明 | 応答 | -| ----- | ---------- | ---------------------------- | ---------------------------------------------- | -| `GET` | `/command` | すべてのコマンドをリストする | <a href={typesUrl}><code>コマンド[]</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | ---------- | ---------------------------- | --------------------------------------------- | +| `GET` | `/command` | すべてのコマンドをリストする | <a href={typesUrl}><code>Command[]</code></a> | --- -### ファイル +### File -| 方法 | パス | 説明 | 応答 | -| ----- | ------------------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------- | -| `GET` | `/find?pattern=<pat>` | ファイル内のテキストを検索 | `path`、`lines`、`line_number`、`absolute_offset`、`submatches` と一致するオブジェクトの配列 | -| `GET` | `/find/file?query=<q>` | ファイルとディレクトリを名前で検索する | `string[]` (パス) | -| `GET` | `/find/symbol?query=<q>` | ワークスペースのシンボルを検索する | <a href={typesUrl}><code>シンボル[]</code></a> | -| `GET` | `/file?path=<path>` | ファイルとディレクトリをリストする | <a href={typesUrl}><code>FileNode[]</code></a> | -| `GET` | `/file/content?path=<p>` | ファイルを読む | <a href={typesUrl}><code>ファイルコンテンツ</code></a> | -| `GET` | `/file/status` | 追跡されたファイルのステータスを取得する | <a href={typesUrl}><code>ファイル[]</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------- | +| `GET` | `/find?pattern=<pat>` | ファイル内のテキストを検索 | `path`、`lines`、`line_number`、`absolute_offset`、`submatches` と一致するオブジェクトの配列 | +| `GET` | `/find/file?query=<q>` | ファイルとディレクトリを名前で検索する | `string[]` (パス) | +| `GET` | `/find/symbol?query=<q>` | ワークスペースのシンボルを検索する | <a href={typesUrl}><code>Symbol[]</code></a> | +| `GET` | `/file?path=<path>` | ファイルとディレクトリをリストする | <a href={typesUrl}><code>FileNode[]</code></a> | +| `GET` | `/file/content?path=<p>` | ファイルを読む | <a href={typesUrl}><code>FileContent</code></a> | +| `GET` | `/file/status` | 追跡されたファイルのステータスを取得する | <a href={typesUrl}><code>File[]</code></a> | #### `/find/file` クエリパラメータ - `query` (必須) — 検索文字列 (あいまい一致) - `type` (オプション) — 結果を `"file"` または `"directory"` に制限します -- `directory` (オプション) — 検索用のプロジェクト ルートをオーバーライドします。 +- `directory` (オプション) — 検索用のプロジェクトルートをオーバーライドします。 - `limit` (オプション) — 最大結果 (1 ～ 200) - `dirs` (オプション) — 従来のフラグ (`"false"` はファイルのみを返します) --- -### ツール (実験的) +### Tool (Experimental) -| 方法 | パス | 説明 | 応答 | -| ----- | ------------------------------------------- | ---------------------------------------------- | ------------------------------------------------ | -| `GET` | `/experimental/tool/ids` | すべてのツール ID をリストする | <a href={typesUrl}><code>ツール ID</code></a> | -| `GET` | `/experimental/tool?provider=<p>&model=<m>` | モデルの JSON スキーマを含むツールをリストする | <a href={typesUrl}><code>ツールリスト</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------------------------------------- | ---------------------------------------------- | -------------------------------------------- | +| `GET` | `/experimental/tool/ids` | すべてのツール ID をリストする | <a href={typesUrl}><code>ToolIDs</code></a> | +| `GET` | `/experimental/tool?provider=<p>&model=<m>` | モデルの JSON スキーマを含むツールをリストする | <a href={typesUrl}><code>ToolList</code></a> | --- -### LSP、フォーマッタ、MCP +### LSP, Formatter, MCP -| 方法 | パス | 説明 | 応答 | -| ------ | ------------ | ---------------------------------- | ----------------------------------------------------------------- | -| `GET` | `/lsp` | LSP サーバーのステータスを取得 | <a href={typesUrl}><code>LSPStatus[]</code></a> | -| `GET` | `/formatter` | フォーマッタのステータスを取得する | <a href={typesUrl}><code>FormatterStatus[]</code></a> | -| `GET` | `/mcp` | MCP サーバーのステータスを取得する | `{ [name: string]: `<a href={typesUrl}>MCPStatus</a>` }` | -| `POST` | `/mcp` | MCP サーバーを動的に追加する | 本文: `{ name, config }`、MCP ステータス オブジェクトを返します。 | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------------ | ---------------------------------- | --------------------------------------------------------------------- | +| `GET` | `/lsp` | LSP サーバーのステータスを取得 | <a href={typesUrl}><code>LSPStatus[]</code></a> | +| `GET` | `/formatter` | フォーマッタのステータスを取得する | <a href={typesUrl}><code>FormatterStatus[]</code></a> | +| `GET` | `/mcp` | MCP サーバーのステータスを取得する | `{ [name: string]: `<a href={typesUrl}><code>MCPStatus</code></a>` }` | +| `POST` | `/mcp` | MCP サーバーを動的に追加する | 本文: `{ name, config }`、MCP ステータスオブジェクトを返します。 | --- -### エージェント +### Agent -| 方法 | パス | 説明 | 応答 | -| ----- | -------- | ------------------------------------------ | -------------------------------------------------- | -| `GET` | `/agent` | 利用可能なすべてのエージェントをリストする | <a href={typesUrl}><code>エージェント[]</code></a> | +| メソッド | パス | 説明 | レスポンス | +| -------- | -------- | ------------------------------------------ | ------------------------------------------- | +| `GET` | `/agent` | 利用可能なすべてのエージェントをリストする | <a href={typesUrl}><code>Agent[]</code></a> | --- -### ロギング +### Logging -| 方法 | パス | 説明 | 応答 | -| ------ | ------ | ---------------------------------------------------------------------- | ------ | -| `POST` | `/log` | ログエントリを書き込みます。本体:`{ service, level, message, extra? }` | うーん | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------ | ---------------------------------------------------------------------- | ---------- | +| `POST` | `/log` | ログエントリを書き込みます。本体:`{ service, level, message, extra? }` | void | --- -### トゥイ - -| 方法 | パス | 説明 | 応答 | -| ------ | ----------------------- | ----------------------------------------------- | ---------------------------------- | -| `POST` | `/tui/append-prompt` | プロンプトにテキストを追加します | うーん | -| `POST` | `/tui/open-help` | ヘルプダイアログを開く | うーん | -| `POST` | `/tui/open-sessions` | セッションセレクターを開く | うーん | -| `POST` | `/tui/open-themes` | テーマセレクターを開く | うーん | -| `POST` | `/tui/open-models` | モデルセレクターを開く | うーん | -| `POST` | `/tui/submit-prompt` | 現在のプロンプトを送信します | うーん | -| `POST` | `/tui/clear-prompt` | プロンプトをクリア | うーん | -| `POST` | `/tui/execute-command` | コマンドを実行する (`{ command }`) | うーん | -| `POST` | `/tui/show-toast` | トーストを表示 (`{ title?, message, variant }`) | うーん | -| `GET` | `/tui/control/next` | 次の制御リクエストを待ちます | コントロールリクエストオブジェクト | -| `POST` | `/tui/control/response` | 制御リクエストに応答する (`{ body }`) | うーん | +### TUI + +| メソッド | パス | 説明 | レスポンス | +| -------- | ----------------------- | ----------------------------------------------- | -------------------------- | +| `POST` | `/tui/append-prompt` | プロンプトにテキストを追加します | void | +| `POST` | `/tui/open-help` | ヘルプダイアログを開く | void | +| `POST` | `/tui/open-sessions` | セッションセレクターを開く | void | +| `POST` | `/tui/open-themes` | テーマセレクターを開く | void | +| `POST` | `/tui/open-models` | モデルセレクターを開く | void | +| `POST` | `/tui/submit-prompt` | 現在のプロンプトを送信します | void | +| `POST` | `/tui/clear-prompt` | プロンプトをクリア | void | +| `POST` | `/tui/execute-command` | コマンドを実行する (`{ command }`) | void | +| `POST` | `/tui/show-toast` | トーストを表示 (`{ title?, message, variant }`) | void | +| `GET` | `/tui/control/next` | 次の制御リクエストを待ちます | 制御リクエストオブジェクト | +| `POST` | `/tui/control/response` | 制御リクエストに応答する (`{ body }`) | void | --- -### 認証 +### Auth -| 方法 | パス | 説明 | 応答 | -| ----- | ----------- | ------------------------------------------------------------------------------ | ------ | -| `PUT` | `/auth/:id` | 認証資格情報を設定します。本文はプロバイダーのスキーマと一致する必要があります | うーん | +| メソッド | パス | 説明 | レスポンス | +| -------- | ----------- | ------------------------------------------------------------------------------ | ---------- | +| `PUT` | `/auth/:id` | 認証資格情報を設定します。本文はプロバイダーのスキーマと一致する必要があります | void | --- -### イベント +### Event -| Method | Path | Description | Response | -| ------ | -------- | ----------------------------------------------------------------------------- | ------------------------- | -| `GET` | `/event` | Server-sent events stream. First event is `server.connected`, then bus events | Server-sent events stream | +| メソッド | パス | 説明 | レスポンス | +| -------- | -------- | ------------------------------------------------------------------------------------- | ------------------------------ | +| `GET` | `/event` | サーバー送信イベントストリーム。最初のイベントは `server.connected`、次にバスイベント | サーバー送信イベントストリーム | --- -### ドキュメント +### Documentation -| 方法 | パス | 説明 | 応答 | -| ----- | ------ | ---------------- | -------------------------------- | -| `GET` | `/doc` | OpenAPI 3.1 仕様 | OpenAPI 仕様を備えた HTML ページ | +| メソッド | パス | 説明 | レスポンス | +| -------- | ------ | ---------------- | -------------------------------- | +| `GET` | `/doc` | OpenAPI 3.1 仕様 | OpenAPI 仕様を備えた HTML ページ | |