範例
儲存庫在 examples/ 放了一些小而能運作的外掛。
每一個旁邊都有測試,能在沒有 Discord 和 PostgreSQL 的情況下執行;只有 migrations.ts 例外,它的測試需要資料庫。
外掛指南(英文)把每個檔案嵌進去,指南裡的程式碼區塊只要和檔案不同,儲存庫的測試就會失敗。
| 檔案 | 示範什麼 |
|---|---|
tools.ts |
agent 能呼叫的工具,附最低層級,以及模型能據以修正的拒絕訊息 |
reply-files.ts |
把原始圖片位元組附在 agent 回覆,並用 harness.files 測試的工具 |
holds.ts |
工具的 hold,以及一條能看到每次工具呼叫的 hold rule,讓呼叫等 owner 核准 |
prompt.ts |
在每一輪 agent 的核心提示詞後面加上的提示詞區段 |
seeds.ts |
第一次啟動時建立的 agent,之後不會被覆蓋 |
events.ts |
一輪開始、一輪結束、團隊變動和關機的 handler |
services.ts |
一個長期執行的計時器服務,有 start、stop 和 busy |
shared-services.ts |
由一個外掛提供、其他外掛用 get、find 和 lazy 讀取的服務,以及取代它的外掛 |
migrations.ts |
外掛自己的資料表,由可重複執行的 migration 建立 |
providers.ts |
填入 images provider 槽位的外掛 |
echo-runtime.ts |
取代 Pi runtime,填入 runtime 槽位 |
preflight.ts |
某個設定是空的就拒絕啟動的檢查 |
interactions.ts |
用 commands.add 新增的斜線子指令 |
http.ts |
公開 listener 上的一條路由,以及一條接受 WebSocket 的路由 |
dashboard.ts |
dashboard 訊息上多出來的幾行 |
selection.ts |
每個 agent 除了自己的工具,還帶著的共同工具 |
packages.ts |
一個 Pi 套件,每個 session 都載入它的擴充 |
session-tools.ts |
工具的 Pi 擴充原始形式 |
channels.ts |
負責某些頻道裡對話的頻道 claim |
study-room.ts |
自己的一種對話:persona、claim 和 context.turns |
support-desk.ts |
一個 background target,決定哪些能被排程或委派 |
fake-surface.ts |
給記憶體內聊天用的聊天 surface,以及提供它的外掛 |
上面的範例一次聚焦一個外掛能力。 想看完整套件的實作,可以從這些指南和原始碼開始:
- 用工具產生圖片並附在回覆裡:drawing 套件指南和套件原始碼。
- 經過驗證的 HTTP console:web 套件指南和套件原始碼。
- 有 owner 核准 hold 的
repo_push和獨立 Pi coding worker:coding 套件指南和套件原始碼。 - 透過 host broker 使用明確授權工具的隔離頻道:sandbox 套件指南和套件原始碼。
- MCP connector 和 remote MCP endpoint:MCP 套件指南和套件原始碼。
- 官方
codex-images複製式外掛填入imagesprovider 槽位;它的範本原始碼是可運作的 provider 實作。 - 官方外掛指南也連到
dice和release-notice的複製式來源。