redis-switchboard-mcp 0.1.0 → 0.1.2

package/README.md

@@ -61,8 +61,6 @@ The result is stateless from the caller's point of view: `execute` in db 2 and d
 
 ### From npm
 
-> The npm package is not published yet. Use the source install below for now.
-
 ```bash
 npm install -g redis-switchboard-mcp
 rsm --help
@@ -131,6 +129,11 @@ The same file can be selected with `REDIS_MCP_CONFIG=/path/to/config.json`.
 
 > **Note:** diagnostics are written to stderr. Never print to stdout from this process — the MCP transport owns it.
 
+> **Running from this repository:** version 0.1.2+ includes a `redis-switchboard-mcp` bin alias,
+> so `npx -y redis-switchboard-mcp` works even when the MCP client's `cwd` is the repository root.
+> For 0.1.1 and earlier, add `--prefix` pointing outside the repository or use
+> `node /absolute/path/to/redis-switchboard-mcp/dist/index.js` (run `npm run build` first).
+
 ---
 
 <h2 align="center">⚙️ Configuration</h2>
@@ -549,6 +552,70 @@ test/               unit, integration and MCP handshake tests
 
 ---
 
+## Publishing
+
+Publishing is automated by [`.github/workflows/publish.yml`](.github/workflows/publish.yml):
+
+- Triggered when a **GitHub Release is published**, or manually via `workflow_dispatch` with an existing tag.
+- Uses **npm Trusted Publishing (GitHub OIDC)** — no long-lived npm token.
+- Checks out the tag, installs dependencies, then runs `npm publish --access public`.
+- `prepublishOnly` runs typecheck, test typecheck, build and the full test suite before uploading.
+
+### One-time setup (Trusted Publishing)
+
+1. Open the npm package settings → **Trusted Publisher** → **GitHub Actions**.
+2. Fill in:
+   - **Organization or user:** `hexiaowu`
+   - **Repository:** `redis-switchboard-mcp`
+   - **Workflow filename:** `publish.yml` (filename only, include `.yml`; do not include `.github/workflows/`)
+   - **Environment name:** leave blank
+3. Click **Add trusted publisher** — the button is not labeled “Save”.
+4. The first publish after configuring must succeed within 2 days to validate the setup.
+
+If the website does not show the add control, use the npm CLI (npm 11.15+):
+
+```bash
+npm install -g npm@11
+npm trust github redis-switchboard-mcp \
+  --file publish.yml \
+  --repo hexiaowu/redis-switchboard-mcp \
+  --allow-publish \
+  --yes
+npm trust list redis-switchboard-mcp
+```
+
+If `npm trust` reports that you must be logged in, run `npm login --auth-type=web` first and complete 2FA.
+
+The workflow already has `permissions: id-token: write`; npm generates provenance automatically, so `--provenance` is not required.
+
+If you prefer a token instead, add an `NPM_TOKEN` repository secret and put
+`env: { NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} }` on the publish step. Use a granular token with Read and write access and **Bypass 2FA** enabled.
+
+### Release flow
+
+```bash
+# 1. Bump the version and update CHANGELOG.md
+npm version patch --no-git-tag-version
+# edit CHANGELOG.md
+
+# 2. Commit and tag
+git add package.json package-lock.json CHANGELOG.md
+git commit -m "chore: release v0.1.2"
+git tag -a v0.1.2 -m "v0.1.2"
+git push origin main --tags
+
+# 3. Create a GitHub Release (this triggers the publish workflow)
+gh release create v0.1.2 --title "v0.1.2" --notes "..."
+```
+
+After the workflow succeeds:
+
+```bash
+npm view redis-switchboard-mcp version dist-tags
+```
+
+Do not commit npm tokens or `.npmrc` files to the repository.
+
 ## License
 
 MIT

package/README.zh-CN.md

@@ -61,8 +61,6 @@ Redis 的 `SELECT` 改变的是**连接**的数据库，而不是某一条命令
 
 ### 从 npm 安装
 
-> 目前尚未发布到 npm。请先使用下面的源码安装方式。
-
 ```bash
 npm install -g redis-switchboard-mcp
 rsm --help
@@ -133,6 +131,11 @@ node dist/index.js
 
 > **注意：** 本进程的诊断日志全部写到 stderr。不要向 stdout 输出任何内容——stdout 属于 MCP 传输。
 
+> **在本仓库内运行：** 0.1.2+ 增加了 `redis-switchboard-mcp` 这个 bin 别名，
+> 因此即使 MCP 客户端的 `cwd` 是仓库根目录，`npx -y redis-switchboard-mcp` 也能正常启动。
+> 0.1.1 及更早版本需要在 npx 上加 `--prefix` 指向仓库外目录，或使用
+> `node /absolute/path/to/redis-switchboard-mcp/dist/index.js`（先 `npm run build`）。
+
 ---
 
 <h2 align="center">⚙️ 配置</h2>
@@ -550,6 +553,70 @@ test/               单元、集成和 MCP 握手测试
 
 ---
 
+## 发布
+
+发布由 [`.github/workflows/publish.yml`](.github/workflows/publish.yml) 自动化：
+
+- **发布 GitHub Release** 时触发，或通过 `workflow_dispatch` 手动指定已有 tag。
+- 使用 **npm Trusted Publishing（GitHub OIDC）**，不需要长期 npm token。
+- 检出对应 tag、安装依赖，然后执行 `npm publish --access public`。
+- 上传前 `prepublishOnly` 会跑类型检查、测试类型检查、构建和完整测试。
+
+### 一次性配置（Trusted Publishing）
+
+1. 打开 npm 包设置 → **Trusted Publisher** → **GitHub Actions**。
+2. 填写：
+   - **Organization or user：** `hexiaowu`
+   - **Repository：** `redis-switchboard-mcp`
+   - **Workflow filename：** `publish.yml`（只写文件名，带 `.yml`，不要写 `.github/workflows/`）
+   - **Environment name：** 留空
+3. 点击 **Add trusted publisher** —— 这个按钮不叫 “Save”。
+4. 配置后的第一次发布要在 **2 天**内成功，否则该 trusted publisher 配置会失效。
+
+如果网页没有显示添加按钮，可以用 npm CLI（npm 11.15+）：
+
+```bash
+npm install -g npm@11
+npm trust github redis-switchboard-mcp \
+  --file publish.yml \
+  --repo hexiaowu/redis-switchboard-mcp \
+  --allow-publish \
+  --yes
+npm trust list redis-switchboard-mcp
+```
+
+如果 `npm trust` 提示必须先登录，先执行 `npm login --auth-type=web` 完成 2FA。
+
+workflow 已经包含 `permissions: id-token: write`；npm 会自动生成 provenance，不需要额外传 `--provenance`。
+
+如果你更想用 token，可以添加 `NPM_TOKEN` repository secret，并在 publish step 上设置
+`env: { NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} }`。token 需要 Read and write 权限，并开启 **Bypass 2FA**。
+
+### 发布流程
+
+```bash
+# 1. 升版本并更新 CHANGELOG.md
+npm version patch --no-git-tag-version
+# 编辑 CHANGELOG.md
+
+# 2. 提交并打 tag
+git add package.json package-lock.json CHANGELOG.md
+git commit -m "chore: release v0.1.2"
+git tag -a v0.1.2 -m "v0.1.2"
+git push origin main --tags
+
+# 3. 创建 GitHub Release（会触发发布 workflow）
+gh release create v0.1.2 --title "v0.1.2" --notes "..."
+```
+
+workflow 成功后验证：
+
+```bash
+npm view redis-switchboard-mcp version dist-tags
+```
+
+不要把 npm token 或 `.npmrc` 提交到仓库。
+
 ## 许可证
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-switchboard-mcp",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A Redis MCP server that switches logical databases per request instead of relying on the connection-level SELECT command.",
   "keywords": [
     "mcp",
@@ -22,7 +22,8 @@
     }
   },
   "bin": {
-    "rsm": "dist/index.js"
+    "rsm": "dist/index.js",
+    "redis-switchboard-mcp": "dist/index.js"
   },
   "files": [
     "dist",