diff --git a/docs/automation/hooks.md b/docs/automation/hooks.md index 05eab0fd187..e6874a57ad6 100644 --- a/docs/automation/hooks.md +++ b/docs/automation/hooks.md @@ -540,7 +540,7 @@ Example event (plugin package install): "findings": [ { "severity": "warn", - "code": "network_fetch", + "ruleId": "network_fetch", "file": "dist/index.js", "line": 88, "message": "Dynamic network fetch detected during install review." diff --git a/docs/cli/mcp.md b/docs/cli/mcp.md index 985634324a9..0d2fb6a566f 100644 --- a/docs/cli/mcp.md +++ b/docs/cli/mcp.md @@ -410,13 +410,45 @@ Example config shape: } ``` -Typical fields: +### Stdio transport -- `command` -- `args` -- `env` -- `cwd` or `workingDirectory` -- `url` +Launches a local child process and communicates over stdin/stdout. + +| Field | Description | +| -------------------------- | --------------------------------- | +| `command` | Executable to spawn (required) | +| `args` | Array of command-line arguments | +| `env` | Extra environment variables | +| `cwd` / `workingDirectory` | Working directory for the process | + +### SSE / HTTP transport + +Connects to a remote MCP server over HTTP Server-Sent Events. + +| Field | Description | +| --------- | ---------------------------------------------------------------- | +| `url` | HTTP or HTTPS URL of the remote server (required) | +| `headers` | Optional key-value map of HTTP headers (for example auth tokens) | + +Example: + +```json +{ + "mcp": { + "servers": { + "remote-tools": { + "url": "https://mcp.example.com", + "headers": { + "Authorization": "Bearer " + } + } + } + } +} +``` + +Sensitive values in `url` (userinfo) and `headers` are redacted in logs and +status output. These commands manage saved config only. They do not start the channel bridge, open a live MCP client session, or prove the target server is reachable. @@ -430,6 +462,6 @@ Current limits: - conversation discovery depends on existing Gateway session route metadata - no generic push protocol beyond the Claude-specific adapter - no message edit or react tools yet -- no dedicated HTTP MCP transport yet +- HTTP/SSE transport connects to a single remote server; no multiplexed upstream yet - `permissions_list_open` only includes approvals observed while the bridge is connected diff --git a/docs/tools/acp-agents.md b/docs/tools/acp-agents.md index d1040c1a415..926ca6d75e9 100644 --- a/docs/tools/acp-agents.md +++ b/docs/tools/acp-agents.md @@ -672,6 +672,13 @@ Notes: See [Plugins](/tools/plugin). +### Automatic dependency install + +When you install OpenClaw globally with `npm install -g openclaw`, the acpx +runtime dependencies (platform-specific binaries) are installed automatically +via a postinstall hook. If the automatic install fails, the gateway still starts +normally and reports the missing dependency through `openclaw acp doctor`. + ### Plugin tools MCP bridge By default, ACPX sessions do **not** expose OpenClaw plugin-registered tools to