feat: built-in AI Assistant with BYO endpoint (v0.6.0, Phase 10)
Add a GUI AI Assistant view (✨ rail) that drives serial + PDU in plain language, without depending on Claude/Kiro. In-process function calling (no MCP hop): Ai/OpenAiChatClient (minimal OpenAI-compatible client) + Ai/AgentHost (hand-written agent loop) + Ai/AiTools (serial via the existing SerialBridge with [AI] echo; PDU via ETTerms.PduCore). BYO endpoint: Base URL / Model / API Key set in Settings → AI Assistant, blank by default = disabled. No private endpoint ships in the app; API key lives in Windows Credential Manager, never in settings.json or code. Safety: destructive PDU actions (outlet off / power-cycle) require a GUI confirmation; every tool call is written to AppLogger. Existing Serial/ PDU MCP servers (Settings → AI MCP) are unaffected and keep serving external AI CLIs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -33,6 +33,7 @@ ETTerms 是一個給工程師 / 韌體 / 硬體驗證人員用的**單一視窗
|
||||
| PDU 控制(選用) | **SnmpSharpNet** | 沿用 MyTeraTerm PDU 控制(`pductrl` / `pduconnect`) |
|
||||
| 日誌 | 自製 **AppLogger**(從 MyTeraTerm 移植) | 檔案 + Debug 雙輸出 |
|
||||
| AI / MCP 整合(選用) | **stdio MCP server**(官方 C# SDK `ModelContextProtocol`) | 兩個獨立 server:`ETTerms.SerialMcp`(不自己開 port,經本機 named pipe 橋接 GUI 持有的 serial session)與 `ETTerms.PduMcp`(直接打 SNMP 控制 PDU 插座,不需 GUI);把收發 / 電源控制暴露成 AI 可呼叫工具(Kiro CLI / Claude CLI),見 [AI / MCP Integration](#ai--mcp-integrationserial-mcp--pdu-mcp-server) |
|
||||
| 內建 AI Assistant(Phase 10 規劃中) | **Microsoft.Extensions.AI**(OpenAI 相容 client + function calling) | GUI 內建 agent 聊天分頁,in-process 直呼 serial / PDU 工具(不經 MCP);**BYO endpoint**——Provider 預設空白,發佈版不含任何私人端點,API key 存 Credential Manager |
|
||||
| 打包 | `dotnet publish` + (選用)Inno Setup / MSIX | 單機安裝,current-user |
|
||||
|
||||
> **與舊版 MyTeraTerm 的關鍵差異:** 舊版是把真正的 `ttermpro.exe`(TeraTerm)嵌進 Panel,靠 **com0com 虛擬 COM 對**攔截 serial 來跑腳本。ETTerms 改走**全原生**:SSH.NET 做 SSH、`System.IO.Ports` 做 serial、自繪 VT100 控制項做終端機畫面,**不再依賴外部 TeraTerm exe,也不再需要 com0com**。腳本引擎從「驅動 com0com bridge」改成「驅動原生 `ISessionChannel`」。
|
||||
@@ -161,6 +162,11 @@ ETTerms/
|
||||
│ └── Pdu/
|
||||
│ └── PduController.cs# SnmpSharpNet PDU 控制 (pductrl / pduconnect)
|
||||
│
|
||||
├── Ai/ # ── 內建 AI Assistant(Phase 10, v0.6.0)──
|
||||
│ ├── OpenAiChatClient.cs # 極簡 OpenAI 相容 /chat/completions(HttpClient, 非串流;BYO endpoint)
|
||||
│ ├── AgentHost.cs # 手寫 agent loop(tool_calls → 執行 → 餵回 → 迴圈,上限 8 輪)
|
||||
│ └── AiTools.cs # 工具集:serial(經 SerialBridge, [AI] echo)+ PDU(PduCore);破壞性動作經 ConfirmAsync 彈框
|
||||
│
|
||||
└── Infrastructure/
|
||||
├── AppLogger.cs # 日誌 (port 自 MyTeraTerm)
|
||||
├── AppSettings.cs # 使用者偏好 (JSON, %LocalAppData%\ETTerms\settings.json)
|
||||
@@ -468,6 +474,37 @@ Kiro/Claude CLI ── 啟動子行程 ETTerms.PduMcp(stdio / JSON-RPC)
|
||||
|
||||
> 所有工具回傳統一的 `{ "ok": bool, "result"/"error": ... }` JSON。SNMP community 目前沿用 GUI 版的 `"private"`。
|
||||
|
||||
### 內建 AI Assistant(Phase 10 — ✅ 已完成 v0.6.0)
|
||||
|
||||
> 讓 ETTerms **自己就是 agent host**——不經 Claude / Kiro,在 GUI 內建 AI 聊天檢視(Activity Rail 的 ✨ view),用自然語言驅動 serial 與 PDU(「接上 COM3,送 help 看回應」「連上 PDU,把 outlet 3 重開」一句話完成)。
|
||||
|
||||
**設計原則:BYO Endpoint(使用者自帶 LLM 端點)**
|
||||
|
||||
- Provider 設定(**Base URL / API Key / Model**)預設**全空白**;未設定時 AI 面板顯示「未設定 AI Provider」且功能完全停用——**發佈出去的 ETTerms 不內含任何端點,對一般使用者就是一個沒有 AI 的終端機**。
|
||||
- API Key 只存 **Windows Credential Manager**(`ETTerms/AiApiKey`,沿用 `CredentialVault`);Base URL / Model 存 settings.json(本機、非 repo)。
|
||||
- 介面走 **OpenAI 相容 `/v1/chat/completions` + function calling**,任何供應商皆可接:本機 Ollama(`http://localhost:11434/v1`)、自架 LiteLLM gateway、公司內部 gateway、OpenAI 等。模型需支援 function calling。
|
||||
- 🚫 **鐵則:任何私人端點 URL / API key 不得出現在程式碼、預設值、文件範例、repo、publish 產物。** 文件範例一律用 `localhost` 或占位符。
|
||||
|
||||
**架構(in-process function calling,不經 MCP)**
|
||||
|
||||
```
|
||||
AiChatView(Activity Rail 的 ✨ view,全頁聊天)
|
||||
└─ AgentHost(Ai/AgentHost.cs):維護對話歷史 + 手寫 agent loop(最多 8 輪工具)
|
||||
├─ OpenAiChatClient(Ai/OpenAiChatClient.cs):極簡 OpenAI 相容 /chat/completions(非串流)→ 使用者設定的 Base URL
|
||||
└─ AiTools(Ai/AiTools.cs):in-process 直呼,不經子行程 / pipe
|
||||
├─ serial_list / attach / write / read → SerialBridge 同一套路徑([AI] 標色照舊;read 端自行累積 RX)
|
||||
└─ pdu_connect / status / set_port / power_cycle → ETTerms.PduCore(本 session 內 IP→controller 登錄)
|
||||
```
|
||||
|
||||
**為何內建 agent 不經 MCP:** MCP 解決的是「跨行程 / 跨信任邊界」(Claude / Kiro 是別人的 process,所以需要 stdio JSON-RPC + named pipe 橋接);內建 agent 與工具在**同一個 process**,直呼即可,插一層「子行程 + 序列化 + pipe」繞一圈回自己記憶體裡的物件,只增加故障面。既有的 SerialMcp / PduMcp **不受影響**,繼續服務外部 AI CLI(Settings → AI MCP)。日後若要開放「使用者掛第三方 MCP server」(ETTerms 作為 **MCP host**),把 MCP client 列出的工具 schema concat 進 `AiTools.GetSchemas()` 的清單即可,agent loop 不需改動。
|
||||
|
||||
**安全設計:**
|
||||
- 破壞性 PDU 動作(`pdu_set_port` off / `pdu_power_cycle`)一律 **C# 端彈確認框**(`AiTools.ConfirmAsync` → GUI MessageBox,預設按鈕 No;不信 LLM 自律)。
|
||||
- 所有 AI 工具呼叫寫 **AppLogger** 留跡(`[AI tool] <name> <args>`)。
|
||||
- Serial TX 沿 Phase 9 慣例以 `[AI]` 標色 echo(`SerialBridgeEndpoint.Write`),使用者全程看得到 AI 打了什麼。
|
||||
|
||||
**實作選型:** 手寫 `OpenAiChatClient`(HttpClient + System.Text.Json,非串流)+ 手寫 agent loop,**不引入 `Microsoft.Extensions.AI`**——依賴最小、對任意 OpenAI 相容 gateway 相容性自己掌控、無額外 NuGet 演進風險。工具 schema 為手組 JSON(OpenAI function-calling 格式)。
|
||||
|
||||
---
|
||||
|
||||
## Key Constraints & Business Rules
|
||||
@@ -482,6 +519,7 @@ Kiro/Claude CLI ── 啟動子行程 ETTerms.PduMcp(stdio / JSON-RPC)
|
||||
8. **GUI 先行:** Phase 1–2 必須先讓視窗外殼 + 分頁 + 假連線可見可操作,再接真實 channel。
|
||||
9. **不依賴外部 exe:** 不嵌 TeraTerm、不需 com0com;全原生 .NET 元件。
|
||||
10. **UI 不可被 channel I/O 阻塞:** channel 讀寫在背景,UI 更新一律 `Invoke` 回 UI thread。
|
||||
11. **AI Provider 預設空白(BYO endpoint):** 內建 AI(Phase 10)未設定端點時完全停用;**任何私人端點 / 金鑰不得進程式碼、預設值、文件範例、publish 產物**。API key 只存 Windows Credential Manager。
|
||||
|
||||
---
|
||||
|
||||
@@ -490,6 +528,7 @@ Kiro/Claude CLI ── 啟動子行程 ETTerms.PduMcp(stdio / JSON-RPC)
|
||||
- **密碼儲存:** 一律使用 **Windows Credential Manager**(透過 `CredentialVault.cs`)。SQLite 內只存索引 `CredentialKey`,無明碼。SSH private key passphrase 同理。
|
||||
- **SSH host key 驗證:** 首次連線顯示 host key 指紋供使用者確認(trust-on-first-use),記錄已信任的指紋,之後比對;指紋不符要警告。
|
||||
- **私鑰檔保護:** private key 路徑存設定,但不複製 key 內容進 repo / SQLite。
|
||||
- **AI Provider(Phase 10):** Base URL / Model 存本機 settings.json、API key 只存 Credential Manager(`ETTerms/AiApiKey`);**無任何預設端點**——發佈產物內不含開發者私人伺服器資訊,文件範例一律 `localhost` / 占位符。AI 工具呼叫全程 AppLogger 留跡,破壞性 PDU 動作需 GUI 確認。
|
||||
- **輸入處理:** 終端機輸入直接透傳給遠端,不做 shell 注入解讀(本來就是終端機);但 UI 載入腳本檔時要防路徑穿越 / 過大檔。
|
||||
- **日誌不含密碼:** `AppLogger` 與 `logopen` 輸出不可寫入密碼 / passphrase;連線資訊只記主機 / port,不記 credential。
|
||||
- **無 `secret/` 資料夾:** ETTerms 無伺服端祕密 / DB 密碼 / compile-time secret,連線密碼一律走 Windows Credential Manager,因此不設 `secret/` 集中目錄,也不需要 publish 類腳本。若日後做 Release 程式碼簽章,簽章 `.pfx` 請放在 repo 外並以環境變數 / CI secret 傳入。
|
||||
@@ -704,6 +743,19 @@ Rename-Item (Join-Path $proot "ETTerms.exe") "ETTerms v$ver.exe"
|
||||
- [x] 註冊說明(`kiro-cli mcp add` / agent.json `mcpServers`)寫入 [docs/serial-mcp-guide.md](docs/serial-mcp-guide.md),含「需先在 GUI 開好 port」前提
|
||||
**驗收條件:** ✅ GUI 開一條 Serial(COM3)→ 另一分頁 PowerShell 跑 kiro → AI 經 MCP `serial_attach` COM3 → `serial_write` 送指令、`serial_read` 讀回應,**整個過程在 GUI Tab1 即時可見(AI 的 TX 有 `[AI]` 標色)**;全程只有 GUI 開該 port。
|
||||
|
||||
### Phase 10 — 內建 AI Assistant(BYO endpoint agent)(工作量:M)✅ 已完成(v0.6.0)
|
||||
**目標:** 不依賴 Claude / Kiro,GUI 內建 AI 聊天檢視,自然語言驅動 serial + PDU;**發佈版不含任何私人端點**(設計見 [內建 AI Assistant](#內建-ai-assistantphase-10--✅-已完成-v060))。
|
||||
**包含:**
|
||||
- [x] `AppSettings` 加 `AiBaseUrl` / `AiModel` / `AiSystemPrompt`(預設空白);API key 存 `CredentialVault`(`ETTerms/AiApiKey`)
|
||||
- [x] `App/SettingsView.cs` 加 **AI Assistant** 分頁:Base URL / Model / API Key(密碼框)/ 系統提示詞,Save 寫 settings + Credential Manager;空白=停用
|
||||
- [x] `App/AiChatView.cs`:Activity Rail ✨ view,聊天 UI(角色標色訊息串 + 輸入框 + 工具過程顯示);`RefreshProvider()` 切入時依最新設定重建 client
|
||||
- [x] `Ai/OpenAiChatClient.cs`:極簡 OpenAI 相容 chat-completions(HttpClient,非串流)
|
||||
- [x] `Ai/AgentHost.cs`:手寫 agent loop(tool_calls → 執行 → role=tool 餵回 → 迴圈,上限 8 輪)
|
||||
- [x] `Ai/AiTools.cs`:serial(list/attach/write/read,經 `SerialBridge`,`[AI]` echo 沿用)+ PDU(connect/status/set_port/power_cycle,`ETTerms.PduCore`);破壞性動作經 `ConfirmAsync` 彈框;每筆呼叫寫 AppLogger
|
||||
- [x] `ActivityRail` 加 `Ai` view(✨);`MainForm` 掛載並在切入時 `RefreshProvider()`
|
||||
- [ ] (延伸,未做)MCP host:讓使用者掛自己的第三方 MCP server(schema concat 進 `AiTools.GetSchemas()`)
|
||||
**驗收條件:** ✅ 建置 0 錯誤;未設定 Provider 時 AI 面板停用並提示;`src` grep 無任何私人端點 / key(範例一律 localhost / 假 IP)。實機端到端(接 OpenAI 相容端點跑 serial/PDU 一句話流程、PDU 確認框、`[AI]` 標色、AppLogger 紀錄)待使用者驗收。
|
||||
|
||||
---
|
||||
|
||||
## Future Extensions
|
||||
|
||||
Reference in New Issue
Block a user