@jeffreycao/copilot-api 2.6.16 → 2.6.17

package/README.md

@@ -232,18 +232,27 @@ Recommended Codex version: `0.155.1`.
 
 ### Codex `config.toml` Reference
 
-Add the following `[model_providers.copilot_api]` section to your Codex `~/.codex/config.toml`:
+Add the following configuration to your Codex `~/.codex/config.toml`:
 
 ```toml
+model = "gpt-6-sol"
+model_reasoning_effort = "max"
 model_provider = "copilot_api"
 model_reasoning_summary = "auto"
+plan_mode_reasoning_effort = "max"
 model_context_window = 272000
-model_auto_compact_token_limit = 244800
+model_auto_compact_token_limit = 254800
+sandbox_mode = "danger-full-access"
+approvals_reviewer = "auto_review"
+suppress_unstable_features_warning = true
 web_search = "live"
+# Codex 0.156.0 and later: generate the catalog, then uncomment this line.
+# model_catalog_json = "model_catalog.json"
 
 [model_providers.copilot_api]
 name = "OpenAI"
 base_url = "http://localhost:4141"
+model_catalog_url = "http://localhost:4141/models"
 env_key = "GITHUB_COPILOT_API_KEY"
 requires_openai_auth = true
 supports_websockets = false
@@ -255,9 +264,11 @@ stream_idle_timeout_ms = 300000
 
 [features]
 remote_compaction_v2 = true
-# optional: set false only when the model does not support tool_search
-apps = false
+api_key_model_discovery = true
+default_mode_request_user_input = true
 standalone_web_search = true
+daemon_auto_start = false
+apps = false
 
 [analytics]
 enabled = false
@@ -265,50 +276,26 @@ enabled = false
 
 > [!NOTE]
 > `name` must be set to `"OpenAI"`.
->
-> For third-party models that do not support `tool_search`, we recommend disabling features.apps. Otherwise, each prompt may consume an additional 20,000 or more tokens.
->
-> `supports_standalone_web_search` and `[features] standalone_web_search` must both be enabled to expose the standalone `web.run` search tool.
 
-### If Codex Is Not Signed In to a GPT Account
+### Generate `model_catalog.json`
 
-```toml
-[model_providers.copilot_api]
-name = "OpenAI"
-base_url = "http://localhost:4141"
-requires_openai_auth = false
-supports_websockets = false
-supports_standalone_web_search = true
-wire_api = "responses"
-request_max_retries = 3
-stream_max_retries = 3
-stream_idle_timeout_ms = 300000
+Codex `0.156.0` and later currently have a bug that prevents loading models through `api_key_model_discovery`. The example leaves `model_catalog_json` commented out by default: generate the file first, then uncomment `model_catalog_json = "model_catalog.json"` to load a local catalog as a workaround. This also works when Codex is not signed in to a GPT account. Versions earlier than `0.156.0` do not need this setting. The [official configuration reference](https://learn.chatgpt.com/docs/config-file/config-reference) describes `model_catalog_json` as a path to a JSON model catalog loaded on startup.
 
-[features]
-standalone_web_search = true
+With the gateway running and `curl` and either Bun or Node.js installed, run [the generator](./docs/generate-model-catalog.sh) from the repository root. The script prefers Bun and falls back to Node.js; `jq` is not required:
 
-[model_providers.copilot_api.auth]
-command = "powershell.exe"
-args = [
-    "-NoProfile",
-    "-NonInteractive",
-    "-Command",
-    "[Console]::Out.Write($env:GITHUB_COPILOT_API_KEY)"
-]
+```sh
+sh docs/generate-model-catalog.sh
 ```
 
-macOS, replace the `auth` block with:
+By default, this writes `$HOME/.codex/model_catalog.json` and creates the directory if needed. With the default gateway URL, the command above is equivalent to specifying the URL and output path explicitly:
 
-```toml
-[model_providers.copilot_api.auth]
-command = "/bin/zsh"
-args = [
-    "-c",
-    "printf '%s' \"$GITHUB_COPILOT_API_KEY\""
-]
+```sh
+sh docs/generate-model-catalog.sh http://localhost:4141 "$HOME/.codex/model_catalog.json"
 ```
 
-Without this configuration, Codex cannot fetch `/v1/models` while not signed in to a GPT account, so custom models are unavailable in the model picker.
+If gateway authentication is enabled, export `GITHUB_COPILOT_API_KEY` before running the script. Set `model_catalog_json` to the generated file's absolute path to avoid ambiguity with relative paths. The script sends a Codex `User-Agent`, validates the returned catalog, and replaces the destination only after a successful download and validation. Run it again after changing gateway models or providers, then restart Codex to load the updated catalog.
+
+### Codex Model Catalog and Protocol Adapters
 
 When a Codex client (`User-Agent` starts with `codex`) requests the top-level `GET /v1/models`, the gateway merges native Codex models with models available through the Messages adapter. The latter advertise `use_responses_lite: true`, except DeepSeek models, which use `use_responses_lite: false` and `tool_mode: null`. For other models, `/v1/responses` uses **Responses → Messages** for Anthropic providers, while OpenAI-compatible providers and Chat-only Copilot models reuse the existing Messages route for **Responses → Messages → Chat Completions**, then translate streaming or JSON results back to Responses.
 

package/README.zh-CN.md

@@ -248,18 +248,27 @@ npx @jeffreycao/copilot-api@latest start
 
 ### Codex `config.toml` 参考配置
 
-把以下 `[model_providers.copilot_api]` 段加入你的 Codex `~/.codex/config.toml`：
+把以下配置加入你的 Codex `~/.codex/config.toml`：
 
 ```toml
+model = "gpt-6-sol"
+model_reasoning_effort = "max"
 model_provider = "copilot_api"
 model_reasoning_summary = "auto"
+plan_mode_reasoning_effort = "max"
 model_context_window = 272000
-model_auto_compact_token_limit = 244800
+model_auto_compact_token_limit = 254800
+sandbox_mode = "danger-full-access"
+approvals_reviewer = "auto_review"
+suppress_unstable_features_warning = true
 web_search = "live"
+# Codex 0.156.0 及以上版本：先生成模型目录文件，再取消下一行的注释。
+# model_catalog_json = "model_catalog.json"
 
 [model_providers.copilot_api]
 name = "OpenAI"
 base_url = "http://localhost:4141"
+model_catalog_url = "http://localhost:4141/models"
 env_key = "GITHUB_COPILOT_API_KEY"
 requires_openai_auth = true
 supports_websockets = false
@@ -271,9 +280,11 @@ stream_idle_timeout_ms = 300000
 
 [features]
 remote_compaction_v2 = true
-# optional: set false only when the model does not support tool_search
-apps = false
+api_key_model_discovery = true
+default_mode_request_user_input = true
 standalone_web_search = true
+daemon_auto_start = false
+apps = false
 
 [analytics]
 enabled = false
@@ -281,50 +292,26 @@ enabled = false
 
 > [!NOTE]
 > `name` 一定要配置为 `"OpenAI"`。
->
-> 对于不支持 `tool_search` 的第三方模型，我们建议禁用 features.apps。否则，每个提示可能会额外消耗 20,000 多个 token。
->
-> 必须同时启用 `supports_standalone_web_search` 和 `[features] standalone_web_search`，Codex 才会暴露独立的 `web.run` 搜索工具。
 
-### Codex 未登录 GPT 账号时
+### 一键生成 `model_catalog.json`
 
-```toml
-[model_providers.copilot_api]
-name = "OpenAI"
-base_url = "http://localhost:4141"
-requires_openai_auth = false
-supports_websockets = false
-supports_standalone_web_search = true
-wire_api = "responses"
-request_max_retries = 3
-stream_max_retries = 3
-stream_idle_timeout_ms = 300000
+Codex `0.156.0` 及以上版本目前存在无法加载 `api_key_model_discovery` 模型列表的 bug。示例默认注释了 `model_catalog_json`，请先生成文件，再取消 `model_catalog_json = "model_catalog.json"` 的注释，通过本地模型目录临时解决。未登录 GPT 账号时也可以使用此方式加载模型目录；低于 `0.156.0` 的版本不需要增加此项。[官方配置参考](https://learn.chatgpt.com/docs/config-file/config-reference)将 `model_catalog_json` 定义为启动时加载的 JSON 模型目录路径。
 
-[features]
-standalone_web_search = true
+启动网关并安装 `curl` 及 Bun 或 Node.js 后，在仓库根目录运行[生成脚本](./docs/generate-model-catalog.sh)。脚本优先使用 Bun，没有 Bun 时使用 Node.js，无需安装 `jq`：
 
-[model_providers.copilot_api.auth]
-command = "powershell.exe"
-args = [
-    "-NoProfile",
-    "-NonInteractive",
-    "-Command",
-    "[Console]::Out.Write($env:GITHUB_COPILOT_API_KEY)"
-]
+```sh
+sh docs/generate-model-catalog.sh
 ```
 
-macOS 将 `auth` 段替换为：
+默认写入 `$HOME/.codex/model_catalog.json`，目录不存在时会自动创建。使用默认网关地址时，上面的命令等价于显式指定网关地址和输出路径：
 
-```toml
-[model_providers.copilot_api.auth]
-command = "/bin/zsh"
-args = [
-    "-c",
-    "printf '%s' \"$GITHUB_COPILOT_API_KEY\""
-]
+```sh
+sh docs/generate-model-catalog.sh http://localhost:4141 "$HOME/.codex/model_catalog.json"
 ```
 
-未按上述方式配置时，Codex 未登录 GPT 账号拉不到 `/v1/models`，无法选择自定义模型。
+如果网关启用了鉴权，请先设置环境变量 `GITHUB_COPILOT_API_KEY`。建议把配置中的 `model_catalog_json` 改成生成文件的绝对路径，避免相对路径歧义。脚本会携带 Codex `User-Agent`，校验返回的模型目录，并仅在下载和校验成功后替换目标文件。网关模型或 provider 发生变化后，重新运行脚本并重启 Codex，即可加载更新后的目录。
+
+### Codex 模型目录与协议适配
 
 Codex 客户端（`User-Agent` 以 `codex` 开头）请求顶层 `GET /v1/models` 时，网关会把原生 Codex 模型与可通过 Messages 适配的模型合并返回。除 DeepSeek 模型外，后者会声明 `use_responses_lite: true`；DeepSeek 模型使用 `use_responses_lite: false` 和 `tool_mode: null`。调用 `/v1/responses` 后，Anthropic provider 走 **Responses → Messages**，OpenAI 兼容 provider 以及只支持 Chat 的 Copilot 模型则复用现有 Messages 路由继续走 **Responses → Messages → Chat Completions**，最终统一翻译回 Responses（包括流式事件）。
 

package/dist/main.js

@@ -30,7 +30,7 @@ if (isMcpFastPath(process.argv)) {
 	const { auth } = await import("./auth-ZoN2_BLX.js");
 	const { debug } = await import("./debug-C4rsL806.js");
 	const { mcp } = await import("./mcp-Byz9h_xz.js");
-	const { start } = await import("./start-CmHlGpmG.js");
+	const { start } = await import("./start-CRE6W4OF.js");
 	await runMain(defineCommand({
 		meta: {
 			name: "copilot-api",

package/dist/{server-DQy_3eXx.js → server-B0LTZeZf.js}

@@ -4062,20 +4062,22 @@ function translateToOpenAI(payload, options = {}) {
 	const { sessionId: metadataPromptCacheKey } = parseUserIdMetadata(payload.metadata?.user_id);
 	const sessionAffinity = requestContext.getStore()?.sessionAffinity?.trim() || null;
 	const promptCacheKey = metadataPromptCacheKey ?? sessionAffinity;
+	const capabilities = {
+		supportPdf: options.supportPdf ?? false,
+		toolContentSupportType: options.toolContentSupportType ?? []
+	};
+	const tools = translateAnthropicToolsToOpenAI(payload.tools);
 	return {
 		model: modelId,
-		messages: translateAnthropicMessagesToOpenAI(payload, modelId, {
-			supportPdf: options.supportPdf ?? false,
-			toolContentSupportType: options.toolContentSupportType ?? []
-		}),
+		messages: translateAnthropicMessagesToOpenAI(payload, modelId, capabilities),
 		max_completion_tokens: payload.max_tokens,
 		stop: payload.stop_sequences,
 		stream: payload.stream,
 		temperature: payload.temperature,
 		top_p: payload.top_p,
 		user: payload.metadata?.user_id,
-		tools: translateAnthropicToolsToOpenAI(payload.tools),
-		tool_choice: translateAnthropicToolChoiceToOpenAI(payload.tool_choice),
+		tools,
+		tool_choice: tools && tools.length > 0 ? translateAnthropicToolChoiceToOpenAI(payload.tool_choice) : void 0,
 		thinking_budget: thinkingBudget,
 		...reasoningEffort ? { reasoning_effort: reasoningEffort } : {},
 		...promptCacheKey ? { prompt_cache_key: promptCacheKey } : {}
@@ -6943,7 +6945,7 @@ function translateFilePart(part, path) {
 	};
 }
 function translateToolChoice(toolChoice, registry) {
-	if (!toolChoice) return void 0;
+	if (!toolChoice || registry.tools.length === 0) return void 0;
 	if (typeof toolChoice === "string") {
 		if (toolChoice === "required") return { type: "any" };
 		return { type: toolChoice };
@@ -12515,4 +12517,4 @@ createServer();
 //#endregion
 export { createServer };
 
-//# sourceMappingURL=server-DQy_3eXx.js.map
+//# sourceMappingURL=server-B0LTZeZf.js.map