AgentKit
Tài liệuBộ kitTham chiếu CLIỨng dụng Desktop

ak codex-agent-runtime

ak codex-agent-runtime register

Đăng ký AgentKit agent runtime vào Codex config theo cách idempotent với timeout và mutation boundary chính xác.

Dùng lệnh này sau khi cài agent cho Codex. Nó thêm hoặc refresh stanza do AgentKit sở hữu [mcp_servers.ak-agent-runtime] trong Codex config.

Cách dùng

ak codex-agent-runtime register [flags]

Lệnh không nhận argument theo vị trí.

Tuỳ chọn

CờMặc địnhMô tả
--codex-home <dir>CODEX_HOME hoặc ~/.codexChọn thư mục chứa config.toml.

Cờ dùng chung nằm trong quy ước CLI. Lệnh không prompt; --yes--no-interactive không đổi mutation.

Config mutation chính xác

Registration ghi định nghĩa server hiệu dụng sau:

[mcp_servers.ak-agent-runtime]
command = "ak"
args = ["codex-agent-runtime", "serve"]
enabled = true
startup_timeout_sec = 10
tool_timeout_sec = 600

Lệnh cũng đặt features.hooks = true. AgentKit stanza bị drift sẽ được thay bằng các giá trị này. MCP server khác và Codex config value chưa model được giữ theo giá trị, nhưng tệp thay đổi được encode lại thành TOML deterministic nên thứ tự, whitespace và comment không phải hợp đồng preservation.

Registration chờ tối đa năm giây với config.toml.lock. Nếu platform không hỗ trợ lock, lệnh tiếp tục kèm warning; lock failure khác làm write thất bại.

Áp dụng, ownership và khôi phục

Không có preview, dry-run, confirmation hay force. Registration mới hoặc drifted ghi atomically qua tệp tạm mode 0600. Chạy lại registration giống hệt trả changed=false và giữ mtime.

Lệnh không tạo backup hoặc rollback record. Copy config.toml trước khi đăng ký nếu comment hoặc format chính xác quan trọng. unregister sau đó chỉ xoá MCP stanza; không restore tệp cũ hay reset features.hooks.

Output và luồng

Human success là một dòng trên stdout. Warning khi lock giảm bảo vệ đi stderr.

--json success là raw object trên stdout, không phải envelope có schema_version/kind. Object có config_path, changed, server_name, command, args, warningsop=register. Trong JSON mode, warning nằm trong object và stderr trống khi success. Flag-parse error có thể vẫn plain text.

Dù tagged help khai báo mã 5 cho lỗi đọc/ghi config, implementation hiện trả lỗi chưa classify và binary thoát 1. Trong --json, failure không emit structured error object; hãy dùng process status và stderr, có thể trống.

Mã thoát

Ý nghĩa
0Stanza đã đăng ký, refresh hoặc đã đúng.
1Home resolution, lock, TOML read/parse/validation hoặc atomic write thất bại.
2Argument hoặc cờ không hợp lệ.

Kiểm tra và gỡ

Restart Codex sau changed registration, rồi kiểm tra discovery mà không mở transport:

ak codex-agent-runtime serve --list-only

Dùng ak codex-agent-runtime unregister để gỡ AgentKit stanza.

Lệnh liên quan