@xelexis/x-broker 0.20.2 → 1.0.1

package/README.md

@@ -1,29 +1,31 @@
 # @xelexis/x-broker
 
-Agent Session Broker로 Claude Code와 Codex 세션을 연결합니다.
+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.
 
-Node.js 22 이상과 npm이 필요합니다. Windows x64, macOS ARM64·x64, Linux x64를 지원합니다. 패키지 하나에 네 클라이언트를 포함합니다.
+English | [한국어](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README.ko.md)
 
-## 준비
+Requires Node.js 22 or later and npm. One package contains four clients: Windows x64, macOS arm64 and x64, and Linux x64.
+
+## Install
 
 ```sh
-npm install -g @xelexis/x-broker@0.20.2
+npm install -g @xelexis/x-broker@1.0.1
 x-broker --version
 ```
 
-게시된 npm 버전을 고정하세요. 서버와 클라이언트 버전은 다를 수 있습니다.
+Pin the published npm version. Server and client versions can differ.
 
-Windows 클라이언트 0.17.3부터는 `%LOCALAPPDATA%\xelexis\x-broker\client-cache\v1\win32-x64`의 버전·SHA-256별 검증된 사본을 실행하므로, 새 launcher로 시작한 세션을 유지한 채 npm 패키지를 업그레이드할 수 있습니다. **0.17.2 이하의 이전 launcher에서 처음 업그레이드할 때는 실행 중인 asb-client를 한 번 모두 종료하세요.** 실행 중인 세션은 MCP를 다시 시작할 때 새 버전을 적용합니다. 캐시 준비가 실패하면 stderr에 한 줄 안내 후 설치 원본을 실행하므로, 그 세션이 실행 중인 동안은 업그레이드 전에 종료해야 합니다. 새 캐시를 만든 실행은 시작 성공 후 게시 7일이 지난 이전 사본(최대 16개)과 1시간 지난 staging을 정리하며, 잠긴 파일은 남깁니다.
+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.
 
-## MCP 설정
+## MCP setup
 
-npx에서 `@latest`를 쓰면 MCP 프로세스를 시작하기 전에 npm 레지스트리 확인과 다운로드로 지연될 수 있습니다. MCP 연결에는 예제처럼 게시된 버전을 고정하고, 같은 버전의 `--version`을 먼저 실행해 준비하세요. `--version`은 버전 확인이며 대화 연결 검사가 아닙니다. 하네스 밖에서 인자 없이 실행한 결과로 부모 대화 연결 여부를 판단하지 마세요.
+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.
 
-기본은 고정 버전 전역 설치 후 `x-broker` 실행입니다. 대안인 `npx -y @xelexis/x-broker@0.20.2`은 세션마다 약 100 MB의 npm 부모 프로세스를 남깁니다. npx 사용자는 아래 `command`를 `npx`로 바꾸고 `args` 앞에 `"-y", "@xelexis/x-broker@0.20.2"`을 추가하세요.
+The default is a pinned global install and the `x-broker` command. The alternative, `npx -y @xelexis/x-broker@1.0.1`, 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.1"` before the other `args`.
 
-macOS·Linux에서는 execve를 지원하는 Node의 wrapper가 client로 교체됩니다. Windows는 execve가 없어 어느 방식이든 node relay가 남지만, 전역 설치는 npm exec 부모를 제거합니다.
+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.
 
- 서버 주소, 프로젝트 이름과 토큰을 실제 값으로 바꾸세요. 토큰을 Git이나 공유 파일에 넣지 마세요.
+Replace the server address, project name and token with real values. Never put a token in Git or a shared file.
 
 **Claude Code — `.mcp.json`**
 
@@ -46,24 +48,24 @@ command = "x-broker"
 args = ["--broker-url", "https://broker.example/mcp?project=brk", "--token", "<project token>"]
 ```
 
-Codex는 신뢰한 프로젝트의 설정만 읽습니다. 기존 설정을 바꿀 때 같은 OS 사용자와 인증 상태 디렉터리를 유지하세요.
+Codex reads the config of trusted projects only. When you change an existing config, keep the same OS user and auth state directory.
 
-MCP 연결을 다시 시작하고 에이전트에게 이 대화를 x-broker에 연결해 달라고 요청하세요. 클라이언트 0.17.1부터 새 대화는 연결을 요청할 때만 등록합니다. 승인 코드가 나오면 관리 화면에서 승인하세요. 승인 없는 등록 토큰은 요청 즉시 등록합니다. 이미 등록한 대화는 자동으로 다시 연결됩니다.
+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.
 
-서버와 클라이언트 0.17.1은 다른 세션의 연결 해제·일시 중지·재개와 `report_bug`를 지원합니다. 서버만 올려도 실행 중인 이전 클라이언트의 도구 목록은 바뀌지 않습니다. 새 도구를 쓰려면 설치 또는 MCP 설정의 패키지 버전도 올리고 각 대화에서 재연결하세요.
+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.
 
-상세 MCP 설정은 [에이전트 안내](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README_AGENT.md)를, 서버 설정은 [설치 안내](https://github.com/xelexis-dev/agent-session-broker-deploy#readme)를 확인하세요.
+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.
 
-여러 프로젝트를 한 대화에 연결하려면 [여러 프로젝트 설정](https://github.com/xelexis-dev/agent-session-broker-deploy/blob/main/README_AGENT.md#여러-프로젝트에-연결하기)을 보세요. 프로젝트마다 MCP entry를 두고, Codex hook과 Kimi 상태 경로도 entry별로 맞춥니다.
+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.
 
-## 업그레이드
+## Upgrade
 
-전역 설치는 `npm install -g @xelexis/x-broker@<권장 버전>`으로 갱신하고 `x-broker --version`을 확인한 뒤 세션을 재시작하거나 MCP를 재연결하세요. npx 사용자는 설정의 고정 버전을 바꾸고 `npx -y @xelexis/x-broker@<권장 버전> --version`으로 준비한 뒤 재연결합니다. 전역 설치 갱신은 별도 npx-pin을 바꾸지 않습니다. 실행 중인 client는 재연결 전까지 기존 버전을 사용합니다. 자세한 절차는 `xbroker_docs topic=upgrade`, 오류는 `topic=errors`를 확인하세요.
+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`.
 
-## 메시지 첨부
+## Message attachments
 
-send_message의 선택 인자 attachment에 이 대화 CWD 아래 상대 경로를 지정합니다. 파일 하나100MiB 이하이며 관리자 허용과 ACK 지원 Claude/Codex 수신자가 필요합니다. 링크·hard link·외부 경로·자격증명 패턴은 거부합니다. 구 서버는 첨부만 unsupported이며 outcome-unknown은 자동 재송신하지 마세요.
+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.
 
-파일은 OS cache의 agent-session-broker/inbox/<sessionKey>/에 저장됩니다. 받은 파일함에는 용량 제한과 완료 파일 자동 삭제가 없습니다. 모델에는 경로·크기·SHA256 또는 오류만 전달합니다. 첨부는 신뢰할 수 없는 데이터이며 자동으로 열지 않습니다. 서버 임시 파일은 업로드30분 뒤 또는 ACK·비활성화·재시작 때 지우며 이미 받은 파일은 회수할 수 없습니다. 경로 검사는 복사·이름 변경한 비밀을 검출하지 못합니다.
+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.
 
 Third-party license texts and notices are included in `THIRD_PARTY_NOTICES`. The software is MIT licensed; see LICENSE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xelexis/x-broker",
-  "version": "0.20.2",
+  "version": "1.0.1",
   "license": "SEE LICENSE IN LICENSE",
   "description": "npx launcher and bundled clients for the Agent Session Broker MCP client (asb-client)",
   "bin": {
@@ -26,5 +26,5 @@
   "bugs": {
     "url": "https://github.com/xelexis-dev/agent-session-broker-deploy#readme"
   },
-  "xBrokerClientInputs": "sha256:630ae15d10db72f5c40f2ccc84954f20e2a6bc20717c30ed3b1809e074e0204b"
+  "xBrokerClientInputs": "sha256:51f3feb0d6d3cb389800d3128f3228902faa002c695a723505f0dd3413f1f7b1"
 }