agent-host-protocol-ui 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,134 @@
1
+ # agent-host-protocol-ui
2
+
3
+ A fully client-side web interface for services implementing the [Agent Host Protocol (AHP)](https://github.com/microsoft/agent-host-protocol), inspired by the **VS Code Agents view**.
4
+
5
+ `agent-host-protocol-ui` runs entirely in the browser without any intermediary backend. It connects directly over WebSockets to any AHP host (such as [`pi-agent-host-protocol`](https://github.com/toumorokoshi/pi-agent-host-protocol)), enabling developers to list, inspect, resume, and drive agent sessions with the full feature fidelity of modern agent IDE environments.
6
+
7
+ ---
8
+
9
+ ## Features (Inspired by VS Code Agents View)
10
+
11
+ - 🌐 **Direct Browser-to-Host Connection:**
12
+ - Connect to local or remote AHP hosts via WebSocket (`ws://` / `wss://` with authentication token query parameters).
13
+ - Multi-host registry persisted in browser `localStorage`.
14
+ - Automatic reconnect, handshake negotiation (0.9.x through 1.x), and state replay (`AhpStateMirror`).
15
+
16
+ - 📋 **Live Session Explorer & Management:**
17
+ - Real-time catalog of active sessions, including live TUI terminal sessions bridged from interactive `pi` instances and background agent workers.
18
+ - Search and filter by session title, working directory, and active status.
19
+ - Create new sessions with working directory selection and model/reasoning effort configuration (`resolveSessionConfig`).
20
+ - Session rename (`session/titleChanged`), archive toggle, and disposal of empty sessions.
21
+
22
+ - 💬 **Full-Fidelity Conversational Turns:**
23
+ - **Streaming Assistant Responses:** High-speed streaming markdown rendering with code syntax highlighting and copy controls.
24
+ - **Collapsible Reasoning Streams:** Real-time visibility into the agent's chain-of-thought, including elapsed timer and token counts.
25
+ - **Rich Tool Call Lifecycle:**
26
+ - Visual inspection of tool names, arguments, and execution statuses (`streaming`, `running`, `completed`, `cancelled`).
27
+ - Tool execution output with unified diff rendering for file edits.
28
+ - **Interactive Tool Approvals:** Permission prompts for sensitive tool executions with Approve / Reject actions (`chat/toolCallConfirmed`).
29
+ - **Resumable Errors:** Mid-turn recovery support when model servers encounter transient errors, offering one-click "Resume Turn" (`chat/turnResume`).
30
+ - **Interactive Input Elicitations:** Renders forms for agent questions (text, number, boolean, single/multi select choices) with direct submission (`ChatInputRequest`).
31
+ - **Turn Metrics:** Per-turn prompt/completion tokens, cached tokens, and execution durations.
32
+
33
+ - ⚡ **Steering, Queueing & Smart Input Composer:**
34
+ - **Slash Command Completions (`/`):** Dynamic autocomplete for skills and prompt templates fetched via the `completions` RPC.
35
+ - **Turn Cancellation:** Prominent Stop / Abort button (`chat/turnCancelled`) while turns are in progress.
36
+ - **Mid-Flight Steering:** Send steering messages (`chat/pendingMessageSet` with `kind: steering`) to adjust the agent's direction without cancelling.
37
+ - **Message Queueing:** Enqueue follow-up prompts (`kind: queued`) that trigger automatically upon turn completion, complete with reorder and delete controls.
38
+ - 🔒 **User Privacy & Zero-Knowledge Security:**
39
+ - **Private Composer Drafting:** Keystrokes and drafts remain strictly in local browser memory; no uncommitted text is broadcast over the network by default.
40
+ - **Client-Side Encryption at Rest:** Persistent state (host configurations, credentials, cached sessions) is encrypted using **Web Crypto API AES-GCM-256** with PBKDF2 key derivation or zero-knowledge ephemeral session keys.
41
+ - **100% Air-Gapped / Zero External Requests:** No third-party analytics, tracking, telemetry, or remote CDN dependencies.
42
+ - **Defense-in-Depth XSS Sanitization:** Strict Content Security Policy (CSP) and DOMPurify sanitization preventing script injection from model or tool output.
43
+ - **Token & Secret Masking:** Host connection tokens and elicitation passwords masked in UI and isolated in memory.
44
+
45
+ - 🖥️ **Integrated Tooling & Auxiliary Panels:**
46
+ - **Interactive Terminals:** Full terminal emulator (xterm.js) embedded in the UI, connected to host ptys via `ahp-terminal:` channels.
47
+ - **Skills & MCP Browser:** Detailed inspector for active skills, prompt templates, and agent tools.
48
+ - **Changeset Inspector:** Review file changes and unified diffs generated during sessions.
49
+
50
+ ---
51
+
52
+ ## Architecture
53
+
54
+ ```
55
+ ┌────────────────────────────────────────────────────────────┐
56
+ │ Browser Session (SPA) │
57
+ │ │
58
+ │ ┌─────────────────────────────────────────────────────┐ │
59
+ │ │ UI Components (Vite + React + CSS) │ │
60
+ │ │ • Host Switcher • Sessions Sidebar • Chat Stream │ │
61
+ │ │ • Composer • Tool Approvals • Terminals │ │
62
+ │ └──────────────────────────┬──────────────────────────┘ │
63
+ │ │ │
64
+ │ ┌──────────────────────────▼──────────────────────────┐ │
65
+ │ │ @microsoft/agent-host-protocol │ │
66
+ │ │ • WebSocketTransport │ │
67
+ │ │ • AhpClient & ManagedSubscriptionManager │ │
68
+ │ │ • AhpStateMirror (Root, Session, Chat State) │ │
69
+ │ └──────────────────────────┬──────────────────────────┘ │
70
+ └──────────────────────────────┼─────────────────────────────┘
71
+ │ WebSocket (JSON-RPC 2.0)
72
+ ▼
73
+ ┌─────────────────────────────────┐
74
+ │ Agent Host Protocol Host │
75
+ │ (e.g., pi-agent-host-protocol) │
76
+ └─────────────────────────────────┘
77
+ ```
78
+
79
+ The application is completely self-contained. It requires no backend server or Node.js proxy to operate—it directly talks JSON-RPC 2.0 over WebSocket to any AHP compliant server.
80
+
81
+ ---
82
+
83
+ ## Quickstart
84
+
85
+ ### Run via npx (Zero Setup)
86
+
87
+ Launch the UI directly in your browser without cloning or installing:
88
+
89
+ ```sh
90
+ npx agent-host-protocol-ui
91
+ ```
92
+
93
+ You can optionally pre-configure the host URL and specify a port:
94
+
95
+ ```sh
96
+ # Pre-configure your local or remote host connection
97
+ npx agent-host-protocol-ui --host "ws://127.0.0.1:63877?tkn=your-token"
98
+
99
+ # Specify a custom port
100
+ npx agent-host-protocol-ui --port 3000
101
+ ```
102
+
103
+ ---
104
+
105
+ ### Local Development
106
+
107
+ #### Prerequisites
108
+ - Node.js 22 or later
109
+ - npm or pnpm
110
+
111
+ ```sh
112
+ # Install dependencies
113
+ npm install
114
+
115
+ # Start development server
116
+ npm run dev
117
+
118
+ # Run linter and typecheck
119
+ just lint
120
+
121
+ # Automatically format and fix issues
122
+ just fix
123
+ ```
124
+
125
+ Once running, navigate to `http://localhost:5173` in your browser. Enter your agent host WebSocket URL (for instance, `ws://127.0.0.1:63877?tkn=your-token`) in the host connection modal to begin interacting with your agent sessions.
126
+
127
+ ---
128
+
129
+ ## Documentation
130
+
131
+ - [Detailed Specification](specs/agent-host-protocol-ui.md)
132
+ - [Security & Privacy Architecture](docs/security.md)
133
+ - [Gaps & Implementation Roadmap](GAPS.md)
134
+ - [License (Apache-2.0)](LICENSE)
package/bin/cli.js ADDED
@@ -0,0 +1,142 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { exec } from "node:child_process";
4
+ import { existsSync, readFileSync, statSync } from "node:fs";
5
+ import http from "node:http";
6
+ import path from "node:path";
7
+ import { fileURLToPath } from "node:url";
8
+
9
+ const __dirname = path.dirname(fileURLToPath(import.meta.url));
10
+ const distDir = path.resolve(__dirname, "../dist");
11
+
12
+ const MIME_TYPES = {
13
+ ".html": "text/html; charset=utf-8",
14
+ ".js": "application/javascript; charset=utf-8",
15
+ ".css": "text/css; charset=utf-8",
16
+ ".json": "application/json; charset=utf-8",
17
+ ".svg": "image/svg+xml",
18
+ ".png": "image/png",
19
+ ".jpg": "image/jpeg",
20
+ ".jpeg": "image/jpeg",
21
+ ".webp": "image/webp",
22
+ ".ico": "image/x-icon",
23
+ ".woff": "font/woff",
24
+ ".woff2": "font/woff2",
25
+ };
26
+
27
+ // Parse command line arguments
28
+ const args = process.argv.slice(2);
29
+ let port = 5173;
30
+ let autoOpen = true;
31
+ let hostParam = "";
32
+
33
+ for (let i = 0; i < args.length; i++) {
34
+ const arg = args[i];
35
+ if (arg === "--port" || arg === "-p") {
36
+ port = Number.parseInt(args[++i], 10) || 5173;
37
+ } else if (arg === "--no-open") {
38
+ autoOpen = false;
39
+ } else if (arg === "--host" || arg === "-h") {
40
+ hostParam = args[++i] || "";
41
+ } else if (arg === "--help") {
42
+ console.log(`
43
+ agent-host-protocol-ui - Client-side UI for Agent Host Protocol
44
+
45
+ Usage:
46
+ npx agent-host-protocol-ui [options]
47
+
48
+ Options:
49
+ -p, --port <number> Port to listen on (default: 5173)
50
+ -h, --host <ws-url> Pre-configure host WebSocket URL
51
+ --no-open Do not automatically open the browser
52
+ --help Show help
53
+ `);
54
+ process.exit(0);
55
+ }
56
+ }
57
+
58
+ if (!existsSync(distDir)) {
59
+ console.error("Error: dist/ directory not found. Please build the application first with 'npm run build'.");
60
+ process.exit(1);
61
+ }
62
+
63
+ const server = http.createServer((req, res) => {
64
+ const urlPath = req.url ? req.url.split("?")[0] : "/";
65
+ let safePath = path.normalize(urlPath).replace(/^(\.\.[/\\])+/, "");
66
+ if (safePath === "/" || safePath === "") {
67
+ safePath = "/index.html";
68
+ }
69
+
70
+ let filePath = path.join(distDir, safePath);
71
+ if (!existsSync(filePath) || statSync(filePath).isDirectory()) {
72
+ // Single Page Application (SPA) fallback to index.html
73
+ filePath = path.join(distDir, "index.html");
74
+ }
75
+
76
+ const ext = path.extname(filePath).toLowerCase();
77
+ const contentType = MIME_TYPES[ext] || "application/octet-stream";
78
+
79
+ try {
80
+ const content = readFileSync(filePath);
81
+ res.writeHead(200, {
82
+ "Content-Type": contentType,
83
+ "Cache-Control": ext === ".html" ? "no-cache" : "public, max-age=31536000, immutable",
84
+ });
85
+ res.end(content);
86
+ } catch (err) {
87
+ const message = err instanceof Error ? err.message : String(err);
88
+ res.writeHead(500, { "Content-Type": "text/plain" });
89
+ res.end(`Internal Server Error: ${message}`);
90
+ }
91
+ });
92
+
93
+ function openBrowser(url) {
94
+ const platform = process.platform;
95
+ let cmd = "";
96
+ if (platform === "darwin") {
97
+ cmd = `open "${url}"`;
98
+ } else if (platform === "win32") {
99
+ cmd = `start "" "${url}"`;
100
+ } else {
101
+ cmd = `xdg-open "${url}"`;
102
+ }
103
+ exec(cmd, () => {});
104
+ }
105
+
106
+ server.on("error", (err) => {
107
+ if (err && typeof err === "object" && "code" in err && err.code === "EADDRINUSE") {
108
+ console.log(`Port ${port} in use, trying ${port + 1}...`);
109
+ port++;
110
+ server.listen(port);
111
+ } else {
112
+ console.error("Server error:", err);
113
+ process.exit(1);
114
+ }
115
+ });
116
+
117
+ server.listen(port, () => {
118
+ let targetUrl = `http://localhost:${port}`;
119
+ if (hostParam) {
120
+ targetUrl += `?host=${encodeURIComponent(hostParam)}`;
121
+ }
122
+ console.log(`
123
+ ┌────────────────────────────────────────────────────────┐
124
+ │ │
125
+ │ Agent Host Protocol UI │
126
+ │ Running at: ${targetUrl.padEnd(41)}│
127
+ │ │
128
+ │ Press Ctrl+C to stop │
129
+ └────────────────────────────────────────────────────────┘
130
+ `);
131
+ if (autoOpen) {
132
+ openBrowser(targetUrl);
133
+ }
134
+ });
135
+
136
+ process.on("SIGINT", () => {
137
+ server.close(() => process.exit(0));
138
+ });
139
+
140
+ process.on("SIGTERM", () => {
141
+ server.close(() => process.exit(0));
142
+ });