@firfi/huly-mcp 0.53.1 → 0.55.1

package/README.md

@@ -45,6 +45,7 @@ The standard configuration uses a Huly API token and works with most MCP clients
       "command": "npx",
       "args": ["-y", "@firfi/huly-mcp@latest"],
       "env": {
+        "MCP_TRANSPORT": "stdio-resident",
         "HULY_URL": "https://your-huly-instance.example.com",
         "HULY_TOKEN": "your-huly-api-token",
         "HULY_WORKSPACE": "yourworkspace"
@@ -73,6 +74,7 @@ Use Codex's MCP manager:
 
 ```bash
 codex mcp add huly \
+  --env MCP_TRANSPORT=stdio-resident \
   --env HULY_URL=https://your-huly-instance.example.com \
   --env HULY_TOKEN=your-huly-api-token \
   --env HULY_WORKSPACE=yourworkspace \
@@ -87,6 +89,7 @@ command = "npx"
 args = ["-y", "@firfi/huly-mcp@latest"]
 
 [mcp_servers.huly.env]
+MCP_TRANSPORT = "stdio-resident"
 HULY_URL = "https://your-huly-instance.example.com"
 HULY_TOKEN = "your-huly-api-token"
 HULY_WORKSPACE = "yourworkspace"
@@ -99,6 +102,7 @@ HULY_WORKSPACE = "yourworkspace"
 
 ```bash
 claude mcp add huly \
+  -e MCP_TRANSPORT=stdio-resident \
   -e HULY_URL=https://your-huly-instance.example.com \
   -e HULY_TOKEN=your-huly-api-token \
   -e HULY_WORKSPACE=yourworkspace \
@@ -131,6 +135,7 @@ Add with Command Palette → "MCP: Add Server", or put this in a VS Code MCP con
       "command": "npx",
       "args": ["-y", "@firfi/huly-mcp@latest"],
       "env": {
+        "MCP_TRANSPORT": "stdio-resident",
         "HULY_URL": "https://your-huly-instance.example.com",
         "HULY_TOKEN": "your-huly-api-token",
         "HULY_WORKSPACE": "yourworkspace"
@@ -168,6 +173,7 @@ Open the global configuration file (`~/.config/opencode/opencode.json`) and merg
       "type": "local",
       "command": ["npx", "-y", "@firfi/huly-mcp@latest"],
       "environment": {
+        "MCP_TRANSPORT": "stdio-resident",
         "HULY_URL": "https://your-huly-instance.example.com",
         "HULY_TOKEN": "your-huly-api-token",
         "HULY_WORKSPACE": "yourworkspace"
@@ -206,7 +212,7 @@ The `@latest` tag asks the package runner for the newest version. Some MCP clien
 | **VS Code / Cursor** | Restart the MCP server from the command palette/configured client or reload the window |
 | **OpenCode** | Restart OpenCode or start a new session after config changes |
 | **Pi** | Run `/mcp reconnect huly`, then `/reload` if the registered direct-tool surface changed |
-| **npx (manual)** | `npx -y @firfi/huly-mcp@latest` — the `-y` flag auto-confirms install prompts |
+| **npx (manual)** | `MCP_TRANSPORT=stdio-resident npx -y @firfi/huly-mcp@latest` — the `-y` flag auto-confirms install prompts |
 
 ## Maintainer Production Release
 
@@ -220,6 +226,18 @@ Use this exact command even when a newer Node.js version is active on the host.
 exact Node.js versions certified by CI; this is intentionally narrower than the package's runtime requirement. See
 the [production release guide](docs/NPM_PRODUCTION_RELEASE.md) for preflight checks, rerun behavior, and verification.
 
+## Shared resident stdio
+
+The setup examples explicitly select `MCP_TRANSPORT=stdio-resident`. MCP clients still use stdio, while compatible clients under the same OS user share a Node backend through small native bridges. Linux and macOS arm64/x64 binaries are included; no Rust installation is needed. If the native bridge cannot run, startup falls back to ordinary stdio before accepting requests. A failed active resident never reconnects or replays requests.
+
+Omitting `MCP_TRANSPORT` still selects ordinary `stdio`, preserving existing installations. Set `MCP_TRANSPORT=stdio` explicitly to keep a separate backend per client. Restart the MCP client after changing the setting.
+
+## Manual resident backend
+
+The experimental [manual resident backend path](docs/resident-manual.md) lets
+independent stdio hosts select one explicitly started local backend through a
+private attachment file. Full qualification remains pending.
+
 ## HTTP Transport
 
 By default, the server uses stdio transport. For HTTP transport:
@@ -264,7 +282,7 @@ Authorization: Bearer <MCP_AUTH_TOKEN>
 
 ### Shared CLI and stdio profiles
 
-Save a profile with `huly auth login --profile work`, then set `HULY_PROFILE=work` in the stdio MCP server's environment. Both processes must run under the same OS user and configuration directory. Stdio never follows the active CLI profile implicitly. Saved tokens are bound to their instance URL and workspace; changes require login again or complete environment credential injection. See the [CLI profile instructions](packages/huly-cli/README.md#authentication-and-profiles). HTTP configuration remains unchanged.
+Save a profile with `huly auth login --profile work`, then set `MCP_TRANSPORT=stdio-resident` and `HULY_PROFILE=work` in the stdio MCP server's environment. Both processes must run under the same OS user and configuration directory. Stdio never follows the active CLI profile implicitly. Saved tokens are bound to their instance URL and workspace; changes require login again or complete environment credential injection. See the [CLI profile instructions](packages/huly-cli/README.md#authentication-and-profiles). HTTP configuration remains unchanged.
 
 ### Hosted HTTP Header Configuration
 
@@ -293,7 +311,8 @@ For a Smithery publish schema example, see [docs/SMITHERY_URL_PUBLISH.md](docs/S
 | `HULY_PASSWORD` | Auth* | Compatibility fallback: account password |
 | `HULY_WORKSPACE` | Yes | Workspace identifier |
 | `HULY_CONNECTION_TIMEOUT` | No | Connection timeout in ms. Omit to use the package default. |
-| `MCP_TRANSPORT` | No | Transport type: `stdio` (default) or `http` |
+| `MCP_TRANSPORT` | No | Transport type: `stdio` (package default), `stdio-resident` (recommended in setup examples), or `http` |
+| `MCP_PRELOAD_TOOLS` | No | Load every tool handler before serving requests. Defaults to `false`; use `true` for smoke tests that check all handler imports. |
 | `MCP_HTTP_PORT` | No | HTTP server port (falls back to `PORT`, then 3000) |
 | `MCP_HTTP_HOST` | No | HTTP server host. Omit to bind to the package default loopback host. |
 | `MCP_AUTH_TOKEN` | No | Optional bearer token required by HTTP clients for `/mcp`. This protects the MCP endpoint only; it is not a Huly API token. |
@@ -306,6 +325,14 @@ For a Smithery publish schema example, see [docs/SMITHERY_URL_PUBLISH.md](docs/S
 *Auth: Prefer `HULY_TOKEN`. Use `HULY_EMAIL` + `HULY_PASSWORD` only when the Huly deployment does not support a
 managed API token or another compatibility constraint requires password authentication.
 
+## Startup and initialization
+
+Tool discovery reads a generated catalog without loading operation handlers or waiting for Huly. Handlers load by tool group on demand; concurrent calls share the group's load. Run `pnpm update-tool-catalog` after changing tool definitions. Builds reject a stale catalog.
+
+For stdio, the first tool-list request starts the process-owned Huly connection in the background. Calls that need the full Huly model wait for the same initialization. Cancelling a waiting call does not cancel initialization for other calls. A failed model initialization can be retried by a later call. Project listing uses a separate REST read and does not wait for the full model. Other operations retain the full model and their existing behavior.
+
+The default transport remains stdio: each process launched by an MCP host owns its connection and model. HTTP lets clients share one running server. Connections created from request credential headers initialize the model only when needed; the CLI also uses this on-demand policy.
+
 ## Built-in Diagnostic Tools
 
 `get_version` returns the current server version and latest npm version.
@@ -1189,6 +1216,22 @@ When resolved tool exposure is `proxy`, clients see the built-in tools plus thes
 
 <!-- tools:end -->
 
+## Building from source
+
+Published packages include the native resident bridge; Rust is a build dependency.
+Source builds require Node.js, pnpm, Rustup, Python 3, and Bash. Prepare the pinned
+Rust toolchain, Zig linker, and cross-compilation SDK once:
+
+```bash
+pnpm setup:native
+pnpm build
+pnpm test:native
+```
+
+Build tools are kept in a platform-specific user cache, outside the checkout and
+published package. The bridge is a single Rust I/O loop; MCP protocol processing,
+authorization, and cancellation remain in the shared Node backend.
+
 ## Troubleshooting
 
 ### Password fallback with special characters
@@ -1214,6 +1257,7 @@ For Claude JSON config, the shell-sensitive characters above can be written dire
       "command": "npx",
       "args": ["-y", "@firfi/huly-mcp@latest"],
       "env": {
+        "MCP_TRANSPORT": "stdio-resident",
         "HULY_URL": "https://your-huly-instance.com",
         "HULY_EMAIL": "you@example.com",
         "HULY_PASSWORD": "p@ss*w0rd!#%",