AgentKit
Tài liệuBộ kitTham chiếu CLIỨng dụng Desktop
BetaBạn đang đọc tài liệu kênh beta (3.0.0-beta.15). Tính năng có thể thay đổi trước bản stable tiếp theo.Chuyển sang stable →

ak codex-agent-runtime

ak codex-agent-runtime serve

Liệt kê Codex agent đã khám phá hoặc chạy stdio MCP server dài hạn dispatch codex exec subprocess mới.

Dùng --list-only để kiểm tra agent discovery. Nếu bỏ cờ này, lệnh chạy stdio MCP server đã đăng ký trong Codex config và block đến khi client disconnect hoặc process bị cancel.

Cách dùng

ak codex-agent-runtime serve [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 user agent dưới <dir>/agents và Codex config ghi nhận trust của project.
--plugin-root <dir>AGENTKIT_PLUGIN_DIR hoặc ~/.claude/pluginsChọn staged Kit agent discovery.
--list-onlyfalseIn discovery rồi thoát mà không mở MCP transport.

Cờ dùng chung nằm trong quy ước CLI, nhưng --json, --quiet, --yes và --no-interactive không đổi serve hoặc list renderer.

Kiểm tra discovery

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

List-only output là plain text trên stdout kể cả với --json. Nó in Codex home, plugin root, dòng project agents: khi tìm thấy thư mục project agent, số lượng, agent slug và nguồn gốc nếu biết: Kit sở hữu, hoặc (project) với project agent. Path và tên có thể nhạy cảm trong support output.

Discovery đọc ba nguồn:

  1. Project agent. <dir>/.codex/agents/ gần nhất tại hoặc phía trên thư mục làm việc, nơi Codex khởi chạy runtime. Việc tìm kiếm dừng ở repository root (thư mục đầu tiên có .git), trước thư mục home của user và ở gốc filesystem. Thư mục chỉ được phục vụ khi Codex config dưới Codex home đã chọn đánh dấu project đó, hoặc repository root chứa nó, là trusted. AgentKit không ghi trust này.
  2. User agent dưới <codex-home>/agents/.
  3. Staged Kit agent dưới <plugin-root>/<kit>/.codex/agents/.

project agents: <dir> nghĩa là thư mục project được phục vụ. project agents: skipped (<reason>) nghĩa là đã tìm thấy nhưng không phục vụ, ví dụ vì project untrusted hoặc chưa được ghi nhận, thư mục .codex hoặc agents là symlink hoặc Windows junction, hoặc thư mục không đọc được; server ghi cùng lý do đó ra stderr khi khởi động. File TOML dạng link bên trong thư mục project bị bỏ qua.

Discovery scan filename *.toml hợp lệ. Project agent thay thế user agent cùng slug, và server ghi chú việc thay thế này ra stderr. User agent ưu tiên hơn staged agent cùng slug; conflict giữa staged Kit resolve theo thứ tự tên Kit. Root thiếu được chấp nhận là rỗng. Root không đọc được trả 1. Tệp agent riêng lẻ không đọc được vẫn xuất hiện với parsed policy rỗng, tức permissive.

Serve qua stdio

ak codex-agent-runtime serve

Stdout chỉ dành cho MCP protocol frame. Không redirect log text vào luồng này. Startup line có server version và agent count đi stderr. Process không đọc input tương tác hay hỏi confirmation.

Mỗi agent thành agent_<slug>. Tool call nhận prompt bắt buộc và tool có tên tuỳ chọn, đọc agent TOML đã cài, kiểm tra policy và start codex exec mới. Prompt được pipe vào subprocess stdin; stdout của nó thành MCP text content. Subprocess fail trả MCP result isError=true cùng stderr đã capture, còn server tiếp tục.

Server process chỉ đọc lúc setup, nhưng codex exec được dispatch có thể truy cập network và sửa tệp trong Codex sandbox hiệu dụng. Agent instruction và user prompt có thể được gửi đến provider. Không có redaction ở command level.

Serve không preflight binary codex. Nó có thể start và list tool khi Codex chưa cài; tool call tương ứng fail lúc dispatch. Registration config đặt timeout 600 giây cho mỗi MCP tool call, còn client kết nối thủ công có thể dùng timeout riêng.

Mã thoát

MãÝ nghĩa
0List-only hoàn tất, client disconnect sạch hoặc command context bị cancel.
1Root resolution, agent discovery hoặc MCP transport thất bại.
2Argument hoặc cờ không hợp lệ.

Dependency/provider exit của dispatch nằm trong MCP result, không phải process exit của server dài hạn.

Lệnh liên quan