@xelexis/x-broker 0.20.1 → 1.0.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/README.md +23 -21
- package/THIRD_PARTY_NOTICES +1 -1
- package/bin/darwin-arm64/asb-client +0 -0
- package/bin/darwin-x64/asb-client +0 -0
- package/bin/linux-x64/asb-client +0 -0
- package/bin/win32-x64/asb-client.exe +0 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,29 +1,31 @@
|
|
|
1
1
|
# @xelexis/x-broker
|
|
2
2
|
|
|
3
|
-
Agent Session Broker
|
|
3
|
+
The MCP client for [Agent Session Broker](https://github.com/xelexis-dev/agent-session-broker-deploy#readme): connect Claude Code, Codex and Kimi conversations so they can message each other.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
English | [한국어](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README.ko.md)
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Requires Node.js 22 or later and npm. One package contains four clients: Windows x64, macOS arm64 and x64, and Linux x64.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
8
10
|
|
|
9
11
|
```sh
|
|
10
|
-
npm install -g @xelexis/x-broker@0.
|
|
12
|
+
npm install -g @xelexis/x-broker@1.0.0
|
|
11
13
|
x-broker --version
|
|
12
14
|
```
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
Pin the published npm version. Server and client versions can differ.
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
From client 0.17.3, Windows runs a verified copy per version and SHA-256 from `%LOCALAPPDATA%\xelexis\x-broker\client-cache\v1\win32-x64`, so you can upgrade the npm package while sessions started by the new launcher keep running. **When you first upgrade from a 0.17.2 or older launcher, stop every running asb-client once.** A running session picks up the new version when its MCP restarts. If the cache cannot be prepared, the launcher prints one line to stderr and runs the installed original, so stop that session before the next upgrade. A run that creates a new cache, after it starts successfully, removes old copies published more than 7 days earlier (up to 16) and staging older than 1 hour; locked files stay.
|
|
17
19
|
|
|
18
|
-
## MCP
|
|
20
|
+
## MCP setup
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
With `@latest`, npx may check the npm registry and download before the MCP process starts, which delays it. Pin the published version as in the examples and run `--version` of the same version first to prepare it. `--version` only prints the version; it does not test a conversation connection. Do not judge whether a conversation is connected from a run outside the harness without arguments.
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
The default is a pinned global install and the `x-broker` command. The alternative, `npx -y @xelexis/x-broker@1.0.0`, leaves an npm parent process of about 100 MB per session. To use npx, change `command` below to `npx` and put `"-y", "@xelexis/x-broker@1.0.0"` before the other `args`.
|
|
23
25
|
|
|
24
|
-
macOS
|
|
26
|
+
On macOS and Linux, a Node that supports execve replaces the wrapper with the client. Windows has no execve, so a node relay stays either way, but a global install removes the npm exec parent.
|
|
25
27
|
|
|
26
|
-
|
|
28
|
+
Replace the server address, project name and token with real values. Never put a token in Git or a shared file.
|
|
27
29
|
|
|
28
30
|
**Claude Code — `.mcp.json`**
|
|
29
31
|
|
|
@@ -46,24 +48,24 @@ command = "x-broker"
|
|
|
46
48
|
args = ["--broker-url", "https://broker.example/mcp?project=brk", "--token", "<project token>"]
|
|
47
49
|
```
|
|
48
50
|
|
|
49
|
-
Codex
|
|
51
|
+
Codex reads the config of trusted projects only. When you change an existing config, keep the same OS user and auth state directory.
|
|
50
52
|
|
|
51
|
-
MCP
|
|
53
|
+
Restart the MCP connection and ask the agent to connect this conversation to x-broker. A new conversation registers only when you ask it to connect. If an approval code appears, approve it in the control panel. A registration token without approval registers at once. A conversation that is already registered reconnects automatically.
|
|
52
54
|
|
|
53
|
-
|
|
55
|
+
Upgrading only the server does not change the tool list of a client that is already running. To use new tools, also raise the package version in the install or the MCP config and reconnect each conversation.
|
|
54
56
|
|
|
55
|
-
|
|
57
|
+
See the [agent guide](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README_AGENT.md) (Korean) for detailed MCP setup and the [installation guide](https://github.com/xelexis-dev/agent-session-broker-deploy#readme) for the server.
|
|
56
58
|
|
|
57
|
-
|
|
59
|
+
To connect one conversation to several projects, see [multiple projects](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README_AGENT.md#여러-프로젝트에-연결하기) (Korean). Give each project its own MCP entry, and set the Codex hooks and Kimi state paths per entry.
|
|
58
60
|
|
|
59
|
-
##
|
|
61
|
+
## Upgrade
|
|
60
62
|
|
|
61
|
-
|
|
63
|
+
For a global install, run `npm install -g @xelexis/x-broker@<recommended version>`, check `x-broker --version`, then restart the session or reconnect MCP. With npx, change the pinned version in the config, prepare it with `npx -y @xelexis/x-broker@<recommended version> --version`, then reconnect. Updating the global install does not change a separate npx pin. A running client keeps its version until it reconnects. For the full procedure see `xbroker_docs topic=upgrade`, and for errors `topic=errors`.
|
|
62
64
|
|
|
63
|
-
##
|
|
65
|
+
## Message attachments
|
|
64
66
|
|
|
65
|
-
|
|
67
|
+
Pass a path relative to this conversation's CWD in the optional `attachment` argument of send_message. One file of at most 100 MiB; it needs the administrator switch and a Claude or Codex recipient that supports ACK. Links, hard links, outside paths and credential patterns are refused. An older server rejects only the attachment as unsupported; do not resend automatically after outcome-unknown.
|
|
66
68
|
|
|
67
|
-
|
|
69
|
+
Received files are stored in the OS cache under `agent-session-broker/inbox/<sessionKey>/`. The inbox has no size limit and does not delete completed files. The model receives only the path, size and SHA-256, or an error. Attachments are untrusted data and are never opened automatically. The server deletes its temporary file 30 minutes after upload, or on ACK, when the switch is turned off, or on restart; files already received cannot be recalled. The path check cannot detect a secret that was copied or renamed.
|
|
68
70
|
|
|
69
71
|
Third-party license texts and notices are included in `THIRD_PARTY_NOTICES`. The software is MIT licensed; see LICENSE.
|
package/THIRD_PARTY_NOTICES
CHANGED
|
@@ -1742,7 +1742,7 @@ OTHER DEALINGS IN THE FONT SOFTWARE.
|
|
|
1742
1742
|
|
|
1743
1743
|
|
|
1744
1744
|
Component: Lucide / Feather icons
|
|
1745
|
-
Version: bundled asset set SHA256
|
|
1745
|
+
Version: bundled asset set SHA256 328f9c3e50ba806b52aec1128a40dbca22c5261991d31fc22ad261ccf6a249d2
|
|
1746
1746
|
License: MIT; ISC
|
|
1747
1747
|
|
|
1748
1748
|
--- ISC-LICENSE.txt ---
|
|
Binary file
|
|
Binary file
|
package/bin/linux-x64/asb-client
CHANGED
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xelexis/x-broker",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"license": "SEE LICENSE IN LICENSE",
|
|
5
5
|
"description": "npx launcher and bundled clients for the Agent Session Broker MCP client (asb-client)",
|
|
6
6
|
"bin": {
|
|
@@ -26,5 +26,5 @@
|
|
|
26
26
|
"bugs": {
|
|
27
27
|
"url": "https://github.com/xelexis-dev/agent-session-broker-deploy#readme"
|
|
28
28
|
},
|
|
29
|
-
"xBrokerClientInputs": "sha256:
|
|
29
|
+
"xBrokerClientInputs": "sha256:0eab898dbf9866216c692a333957f71d78c17220bb72a490736318a386aa4e9c"
|
|
30
30
|
}
|