wazuh-mcp 1.0.0 → 2.0.0

package/README.md

@@ -1,76 +1,107 @@
-# wazuh-mcp
+<p align="center">
+  <img src="docs/assets/wazuh-mcp-social-preview.jpg" alt="wazuh-mcp banner" width="900">
+</p>
 
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.7-blue.svg)](https://www.typescriptlang.org/)
-[![Node.js](https://img.shields.io/badge/Node.js-20%2B-green.svg)](https://nodejs.org/)
-[![MCP](https://img.shields.io/badge/MCP-1.12-purple.svg)](https://modelcontextprotocol.io/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+<p align="center">
+  <a href="https://lidless.dev"><img src="docs/assets/marks/wazuh-mcp-circle.png" width="48" alt="Lidless Labs"></a>
+</p>
 
-A [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server for the [Wazuh](https://wazuh.com/) SIEM/XDR platform. Query agents, security alerts, detection rules, and decoders directly from Claude or any MCP-compatible client.
+<h1 align="center">wazuh-mcp</h1>
 
-## Features
+<p align="center">
+  <strong>A read-only Wazuh SIEM/XDR control CLI and MCP adapter for alerts, agents, vulnerabilities, rules, and more.</strong>
+</p>
 
-- **25 MCP Tools** - Agents, alerts, rules, decoders, SCA, syscollector, FIM, rootcheck, groups, and manager
-- **3 MCP Resources** - Pre-built views for agents, recent alerts, and rule summaries
-- **3 MCP Prompts** - Alert investigation, agent health checks, and security overviews
-- **JWT Authentication** - Automatic token management with refresh on expiry
-- **Full Compliance Mapping** - PCI-DSS, GDPR, HIPAA, NIST 800-53, MITRE ATT&CK
-- **Pagination** - All list endpoints support limit/offset pagination
-- **Type-Safe** - Full TypeScript with strict mode and Zod schema validation
+<p align="center">
+  <strong>Website:</strong> <a href="https://lidless.dev/wazuh-mcp">lidless.dev/wazuh-mcp</a>
+</p>
 
-## Prerequisites
+<p align="center">
+  <img src="https://shieldcn.dev/github/ci/lidless-labs/wazuh-mcp.svg?branch=main&workflow=ci.yml" alt="CI status">
+  <img src="https://shieldcn.dev/npm/wazuh-mcp.svg" alt="npm version">
+  <img src="https://shieldcn.dev/badge/MCP-server-8A2BE2.svg" alt="MCP server">
+  <img src="https://shieldcn.dev/badge/license-MIT-green.svg" alt="MIT License">
+  <img src="https://shieldcn.dev/badge/Wazuh-SIEM%2FXDR-3385ff.svg" alt="Wazuh SIEM/XDR">
+  <img src="https://shieldcn.dev/badge/MITRE_ATT%26CK-mapped-0f766e.svg" alt="MITRE ATT&CK mapped">
+</p>
 
-- Node.js 20+
-- A running Wazuh manager with API access (default port 55000)
-- Wazuh API credentials (username/password)
-- (Optional) Wazuh Indexer (OpenSearch) access for alert queries
+wazuhctrl is a read-only control CLI for the [Wazuh](https://wazuh.com/) SIEM/XDR platform. The same package ships `wazuh-mcp`, a [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) adapter that exposes your Wazuh manager and Wazuh Indexer as MCP tools so Claude, Claude Code, or any MCP-compatible client can investigate alerts, triage agents, and pull vulnerability inventory in plain language. It is read-only by design and security-first: TLS verification is on by default, sensitive fields (agent IPs, full logs, file hashes, command lines) are hidden unless you opt in per call, and attacker-controlled SIEM text is wrapped in untrusted-data markers to blunt prompt injection against the calling model.
+
+## What it does
+
+wazuhctrl and wazuh-mcp turn a Wazuh SIEM/XDR deployment into typed operator surfaces. Point your MCP client at the server, give it your Wazuh manager and (optionally) Wazuh Indexer credentials, and the model can list active and disconnected agents, retrieve and full-text search security alerts, pull vulnerability inventory by CVE or severity, inspect detection rules and decoders, review SCA (Security Configuration Assessment) results, walk system inventory (OS, packages, processes, ports, network, hotfixes), read File Integrity Monitoring and rootcheck findings, fetch manager logs and configuration, and run a connection diagnostic. The CLI starts with status, agent inventory, and diagnostics for shells, cron, and CI. The package ships 28 MCP tools, 3 resources, and 3 guided prompts over stdio. Both surfaces only read from Wazuh: the sole writes they perform are JWT authentication against the manager and `_search` queries against the indexer.
 
 ## Installation
 
+The quickstart below runs the published npm package with `npx`, which is the recommended path. To work from source instead:
+
 ```bash
-git clone https://github.com/solomonneas/wazuh-mcp.git
+git clone https://github.com/lidless-labs/wazuh-mcp.git
 cd wazuh-mcp
 npm install
 npm run build
 ```
 
-## Configuration
+## Quickstart
 
-Set the following environment variables:
+Run it straight from npm with `npx`, no clone or build required:
 
-| Variable | Required | Default | Description |
-|----------|----------|---------|-------------|
-| `WAZUH_URL` | Yes | - | Wazuh API URL (e.g., `https://10.0.0.2:55000`) |
-| `WAZUH_USERNAME` | Yes | - | API username |
-| `WAZUH_PASSWORD` | Yes | - | API password |
-| `WAZUH_VERIFY_SSL` | No | `false` | Set to `true` to verify SSL certificates |
+```json
+{
+  "mcpServers": {
+    "wazuh": {
+      "command": "npx",
+      "args": ["-y", "wazuh-mcp"],
+      "env": {
+        "WAZUH_URL": "https://your-wazuh-manager:55000",
+        "WAZUH_USERNAME": "wazuh-wui",
+        "WAZUH_PASSWORD": "your-password",
+        "WAZUH_INDEXER_URL": "https://your-wazuh-indexer:9200",
+        "WAZUH_INDEXER_USERNAME": "admin",
+        "WAZUH_INDEXER_PASSWORD": "your-indexer-password"
+      }
+    }
+  }
+}
+```
 
-Alternative variable names `WAZUH_BASE_URL` and `WAZUH_USER` are also supported.
+Drop that into your MCP client's server config (see [Usage](#usage) for the exact file per client), restart the client, and ask it something like *"list the active Wazuh agents"* or *"search alerts for brute force in the last 24 hours."* The indexer settings are optional: without them the agent, rule, decoder, and version tools still work, and the alert and vulnerability tools return a configuration message instead of failing.
 
-### Wazuh Indexer (OpenSearch) - Required for Alerts
+Prefer a global install?
 
-Wazuh 4.x stores alerts in the Wazuh Indexer (OpenSearch), not the REST API. To enable alert tools (`get_alerts`, `get_alert`, `search_alerts`) and the `wazuh://alerts/recent` resource, configure the indexer connection:
+```bash
+npm install -g wazuh-mcp
+# then use "command": "wazuh-mcp" instead of the npx invocation above
+```
 
-| Variable | Required | Default | Description |
-|----------|----------|---------|-------------|
-| `WAZUH_INDEXER_URL` | No | - | Wazuh Indexer URL (e.g., `https://10.0.0.2:9200`) |
-| `WAZUH_INDEXER_USERNAME` | No | `admin` | Indexer username |
-| `WAZUH_INDEXER_PASSWORD` | No | - | Indexer password |
-| `WAZUH_INDEXER_VERIFY_SSL` | No | `false` | Set to `true` to verify SSL certificates |
+## CLI
 
-If `WAZUH_INDEXER_URL` is not set, alert tools will return a helpful configuration message. All other tools (agents, rules, decoders, version) work without the indexer.
+The package ships `wazuhctrl` for shells, cron, and CI. Compatibility alias `wazuhctl` points at the same binary, and `wazuh-mcp` remains the MCP stdio adapter.
+
+```bash
+wazuhctrl status --json
+wazuhctrl agents list --limit 20
+wazuhctrl diagnostics
+wazuhctrl diagnostics --no-connectivity
+wazuhctrl mcp
+```
+
+`wazuhctrl` reads the same environment as the MCP adapter: `WAZUH_URL`, `WAZUH_USERNAME`, `WAZUH_PASSWORD`, optional `WAZUH_INDEXER_URL`, and optional indexer credentials. Agent IP addresses stay hidden unless a command explicitly requests them.
 
 ## Usage
 
+The quickstart `mcpServers` block at the top works for most clients. The per-client recipes below give you the exact file location or CLI command for each.
+
 ### Claude Desktop
 
-Add to your Claude Desktop configuration (`claude_desktop_config.json`):
+Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
 
 ```json
 {
   "mcpServers": {
     "wazuh": {
-      "command": "node",
-      "args": ["/path/to/wazuh-mcp/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "wazuh-mcp"],
       "env": {
         "WAZUH_URL": "https://your-wazuh-manager:55000",
         "WAZUH_USERNAME": "wazuh-wui",
@@ -84,39 +115,108 @@ Add to your Claude Desktop configuration (`claude_desktop_config.json`):
 }
 ```
 
+### Claude Code
+
+```bash
+claude mcp add wazuh \
+  --env WAZUH_URL=https://your-wazuh-manager:55000 \
+  --env WAZUH_USERNAME=wazuh-wui \
+  --env WAZUH_PASSWORD=your-password \
+  --env WAZUH_INDEXER_URL=https://your-wazuh-indexer:9200 \
+  --env WAZUH_INDEXER_USERNAME=admin \
+  --env WAZUH_INDEXER_PASSWORD=your-indexer-password \
+  -- npx -y wazuh-mcp
+```
+
+Add `--scope user` to make it available from any directory instead of only the current project.
+
+### Codex CLI
+
+[Codex CLI](https://github.com/openai/codex) registers MCP servers via `codex mcp add`:
+
+```bash
+codex mcp add wazuh \
+  --env WAZUH_URL=https://your-wazuh-manager:55000 \
+  --env WAZUH_USERNAME=wazuh-wui \
+  --env WAZUH_PASSWORD=your-password \
+  --env WAZUH_INDEXER_URL=https://your-wazuh-indexer:9200 \
+  --env WAZUH_INDEXER_USERNAME=admin \
+  --env WAZUH_INDEXER_PASSWORD=your-indexer-password \
+  -- npx -y wazuh-mcp
+```
+
+Codex writes the entry to `~/.codex/config.toml` under `[mcp_servers.wazuh]`. Verify with `codex mcp list`.
+
 ### OpenClaw
 
-Add to your `openclaw.json`:
+With the npm package:
 
-```json
-{
-  "mcp": {
-    "servers": {
-      "wazuh": {
-        "type": "stdio",
-        "command": "node",
-        "args": ["/path/to/wazuh-mcp/dist/index.js"],
-        "env": {
-          "WAZUH_URL": "https://your-wazuh-manager:55000",
-          "WAZUH_USERNAME": "wazuh-wui",
-          "WAZUH_PASSWORD": "your-password",
-          "WAZUH_INDEXER_URL": "https://your-wazuh-indexer:9200",
-          "WAZUH_INDEXER_USERNAME": "admin",
-          "WAZUH_INDEXER_PASSWORD": "your-indexer-password"
-        }
-      }
-    }
+```bash
+openclaw mcp set wazuh '{
+  "command": "npx",
+  "args": ["-y", "wazuh-mcp"],
+  "env": {
+    "WAZUH_URL": "https://your-wazuh-manager:55000",
+    "WAZUH_USERNAME": "wazuh-wui",
+    "WAZUH_PASSWORD": "your-password",
+    "WAZUH_INDEXER_URL": "https://your-wazuh-indexer:9200",
+    "WAZUH_INDEXER_USERNAME": "admin",
+    "WAZUH_INDEXER_PASSWORD": "your-indexer-password"
   }
-}
+}'
+```
+
+Or, when running from a source checkout, point `command`/`args` at the built `dist/mcp-bin.js`:
+
+```bash
+openclaw mcp set wazuh '{
+  "command": "node",
+  "args": ["/absolute/path/to/wazuh-mcp/dist/mcp-bin.js"],
+  "env": {
+    "WAZUH_URL": "https://your-wazuh-manager:55000",
+    "WAZUH_USERNAME": "wazuh-wui",
+    "WAZUH_PASSWORD": "your-password",
+    "WAZUH_INDEXER_URL": "https://your-wazuh-indexer:9200",
+    "WAZUH_INDEXER_USERNAME": "admin",
+    "WAZUH_INDEXER_PASSWORD": "your-indexer-password"
+  }
+}'
+```
+
+Then restart the gateway so the new server is picked up:
+
+```bash
+systemctl --user restart openclaw-gateway
+openclaw mcp list   # confirm "wazuh" is registered
 ```
 
+### Hermes Agent
+
+[Hermes Agent](https://github.com/NousResearch/hermes-agent) reads MCP config from `~/.hermes/config.yaml` under the `mcp_servers` key. Add an entry:
+
+```yaml
+mcp_servers:
+  wazuh:
+    command: "npx"
+    args: ["-y", "wazuh-mcp"]
+    env:
+      WAZUH_URL: "https://your-wazuh-manager:55000"
+      WAZUH_USERNAME: "wazuh-wui"
+      WAZUH_PASSWORD: "your-password"
+      WAZUH_INDEXER_URL: "https://your-wazuh-indexer:9200"
+      WAZUH_INDEXER_USERNAME: "admin"
+      WAZUH_INDEXER_PASSWORD: "your-indexer-password"
+```
+
+Then reload MCP from inside a Hermes session with `/reload-mcp`.
+
 ### Standalone
 
 ```bash
 export WAZUH_URL=https://your-wazuh-manager:55000
 export WAZUH_USERNAME=wazuh-wui
 export WAZUH_PASSWORD=your-password
-npm start
+npx -y wazuh-mcp
 ```
 
 ### Development
@@ -129,6 +229,8 @@ npm test       # Run tests
 
 ## MCP Tools
 
+All 28 tools are read-only.
+
 ### Agent Tools
 
 | Tool | Description |
@@ -141,9 +243,16 @@ npm test       # Run tests
 
 | Tool | Description |
 |------|-------------|
-| `get_alerts` | Retrieve recent alerts with filtering by level, agent, rule, and text search |
+| `get_alerts` | Retrieve recent alerts with filtering by time range, level, agent, rule, and text search |
 | `get_alert` | Retrieve a single alert by ID |
-| `search_alerts` | Full-text search across all alerts |
+| `search_alerts` | Full-text search across alerts with optional time range filtering |
+
+### Vulnerability Tools
+
+| Tool | Description |
+|------|-------------|
+| `list_vulnerabilities` | List vulnerability inventory with optional CVE, agent, severity, and package filters |
+| `search_vulnerabilities` | Search vulnerability inventory by CVE, package, agent, or description |
 
 ### Rule Tools
 
@@ -183,7 +292,7 @@ npm test       # Run tests
 | Tool | Description |
 |------|-------------|
 | `get_manager_logs` | Get Wazuh manager logs filtered by level and module |
-| `get_manager_config` | Get active manager configuration by section |
+| `get_manager_config` | Get active manager configuration by section with secret-like values redacted by default |
 
 ### Group Tools
 
@@ -198,6 +307,94 @@ npm test       # Run tests
 |------|-------------|
 | `list_decoders` | List log decoders with optional name filtering |
 | `get_wazuh_version` | Get Wazuh manager version and API info |
+| `diagnose_wazuh_connection` | Check sanitized configuration, URL/TLS settings, manager auth/version, and indexer readiness |
+
+## Configuration
+
+Set the following environment variables:
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `WAZUH_URL` | Yes | - | Wazuh API URL (e.g., `https://192.0.2.2:55000`). Must be `https://` (or `http://` with `WAZUH_ALLOW_INSECURE_HTTP=true`), and must not contain embedded credentials, a query string, or a fragment. A path prefix for a reverse proxy is allowed. |
+| `WAZUH_USERNAME` | Yes | - | API username |
+| `WAZUH_PASSWORD` | Yes | - | API password |
+| `WAZUH_VERIFY_SSL` | No | `true` | Verifies SSL certificates by default. Set to `false` (also accepts `0`/`no`/`off`) to disable verification for trusted self-signed lab environments only. |
+| `WAZUH_CA_FILE` | No | - | Path to a PEM CA bundle used to verify the manager's TLS certificate (private CA or self-signed). Read at startup; the server exits with an error if the file cannot be read. Prefer this over `WAZUH_VERIFY_SSL=false`. |
+| `WAZUH_ALLOW_INSECURE_HTTP` | No | `false` | Allow plain `http://` for `WAZUH_URL` and `WAZUH_INDEXER_URL`. When unset, `http://` URLs are rejected at startup. When enabled and in use, the server prints a startup warning to stderr. Trusted lab networks only. |
+| `WAZUH_TIMEOUT` | No | `30` | Request timeout in seconds. Must be a positive integer. |
+| `WAZUH_ALLOW_SENSITIVE_CONFIG` | No | `false` | Server-side gate for `get_manager_config`. When unset/`false`, sensitive configuration values are always redacted even if the tool's `include_sensitive_config` argument is `true`. Set to `true` (also accepts `1`/`yes`/`on`) to allow unredacted output when explicitly requested. |
+| `WAZUH_MCP_MAX_RESPONSE_BYTES` | No | `250000` | Maximum MCP tool response size before returning a truncated preview with metadata. Values below `1024` are raised to `1024`. The truncated envelope itself always fits within the cap. |
+| `WAZUH_MCP_MAX_STDIO_BUFFER_BYTES` | No | `8388608` (8 MiB) | Maximum stdio read-buffer size in bytes. Must be a positive integer. A single client message exceeding it makes the transport error and close. |
+
+Alternative variable names `WAZUH_BASE_URL` and `WAZUH_USER` are also supported.
+
+### Wazuh Indexer (OpenSearch) - Required for Alerts and Vulnerabilities
+
+Wazuh 4.x stores alerts and vulnerability inventory in the Wazuh Indexer (OpenSearch), not the REST API. To enable alert tools (`get_alerts`, `get_alert`, `search_alerts`), vulnerability tools (`list_vulnerabilities`, `search_vulnerabilities`), and the `wazuh://alerts/recent` resource, configure the indexer connection:
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `WAZUH_INDEXER_URL` | No | - | Wazuh Indexer URL (e.g., `https://192.0.2.2:9200`). Same URL rules as `WAZUH_URL`. |
+| `WAZUH_INDEXER_USERNAME` | No | `admin` | Indexer username |
+| `WAZUH_INDEXER_PASSWORD` | Yes, when `WAZUH_INDEXER_URL` is set | - | Indexer password. The server fails fast at startup if `WAZUH_INDEXER_URL` is set without it. |
+| `WAZUH_INDEXER_VERIFY_SSL` | No | `true` | Verifies SSL certificates by default. Set to `false` (also accepts `0`/`no`/`off`) to disable verification for trusted self-signed lab environments only. |
+| `WAZUH_INDEXER_CA_FILE` | No | - | Path to a PEM CA bundle used to verify the indexer's TLS certificate. Read at startup; the server exits with an error if the file cannot be read. |
+| `WAZUH_INDEXER_TIMEOUT` | No | `30` | Indexer request timeout in seconds. Must be a positive integer. |
+
+If `WAZUH_INDEXER_URL` is not set, alert and vulnerability tools will return a helpful configuration message. All other tools (agents, rules, decoders, version) work without the indexer.
+
+Indexer searches count at most 10000 matching hits and carry a 30-second server-side `timeout`. When the real match count is higher, `pagination.total_is_lower_bound` is `true` and `total` is 10000. Alert and vulnerability tools accept `offset` up to 9999 and reject requests where `offset + limit` exceeds 10000 (OpenSearch's default `max_result_window`); narrow the query with filters or a time range instead of paging deeper.
+
+SSL certificate verification is enabled by default (secure by default). When either SSL verification setting is explicitly set to `false`, the server prints a startup warning to stderr. TLS verification is disabled only for that configured Wazuh client.
+
+### Sensitive Output Defaults
+
+Several tools return minimized output by default to avoid exposing raw logs, IPs, command lines, hashes, or raw event payloads unless requested:
+
+| Tool | Hidden by default | Opt-in field |
+|------|-------------------|--------------|
+| `list_agents`, `get_agent`, `get_group_agents` | Agent IP details | `include_ip: true` |
+| `get_alerts`, `search_alerts` | `full_log` | `include_full_log: true` |
+| `get_alert` | `full_log`, raw `data` | `include_full_log: true`, `include_raw_data: true` |
+| `list_vulnerabilities`, `search_vulnerabilities` | Vulnerability descriptions | `include_description: true` |
+| `get_agent_processes` | Process command lines and arguments | `include_command: true` |
+| `get_fim_files` | MD5 and SHA-256 hashes | `include_hashes: true` |
+| `get_manager_logs` | Full log descriptions | `include_description: true` |
+| `get_manager_config` | Secret-like config values | `include_sensitive_config: true` (only honored when the server-side `WAZUH_ALLOW_SENSITIVE_CONFIG` flag is enabled; otherwise always redacted) |
+
+### Untrusted SIEM Content
+
+Alert, log, and inventory fields originate on monitored endpoints: anyone who can write a log line to a monitored host (a failed SSH login with a crafted username, a web request path, a syslog message) or control a process, package, file, or hostname on it controls the text that lands in `full_log`, alert `rule_description`, `agent_name`, `location`, and `decoder`, raw event `data`, manager log descriptions, agent names and OS fields, syscollector process/package/port/interface/hotfix fields, FIM paths and owners, rootcheck events, SCA policy and check text, and vulnerability package and description fields. To blunt prompt injection against the calling agent, the server wraps those values in `<untrusted_siem_data>...</untrusted_siem_data>` markers, includes an `output.untrusted_data_note` warning in affected responses, and states in the tool descriptions that the content is attacker-influenced data, never instructions to follow.
+
+### Input Validation
+
+Tool inputs are validated before requests are sent to Wazuh. Pagination is bounded, search text is length-limited, sort fields are enumerated per tool, and path-oriented identifiers such as agent IDs, alert IDs, group IDs, and SCA policy IDs reject unsupported characters.
+
+Paginated tool responses include a `pagination` object with `total`, `limit`, `offset`, and `has_more` fields while preserving the existing top-level `total`, `limit`, and `offset` fields.
+
+Tool responses are capped by `WAZUH_MCP_MAX_RESPONSE_BYTES`. Oversized responses return valid JSON with `output.response_truncated`, byte counts, and a preview instead of flooding the MCP client.
+
+Transient manager `GET` requests and indexer search/readiness requests retry briefly on `429`, `502`, `503`, `504`, and common transient network reset or timeout errors.
+
+## Features
+
+- **28 MCP Tools** - Agents, alerts, vulnerabilities, rules, decoders, SCA, syscollector, FIM, rootcheck, groups, manager, and diagnostics
+- **3 MCP Resources** - Pre-built views for agents, recent alerts, and rule summaries
+- **3 MCP Prompts** - Alert investigation, agent health checks, and security overviews
+- **Read-only by design** - The only writes are JWT auth and indexer `_search`; no tool changes Wazuh state
+- **Secure by default** - TLS verification on, sensitive fields redacted unless opted in, untrusted SIEM content delimited, every error sanitized before it reaches the client
+- **JWT Authentication** - Automatic token management with refresh on expiry
+- **Full Compliance Mapping** - PCI-DSS, GDPR, HIPAA, NIST 800-53, MITRE ATT&CK
+- **Pagination** - All list endpoints support limit/offset pagination
+- **Type-Safe** - Full TypeScript with strict mode and Zod schema validation
+
+## Prerequisites
+
+- Node.js 22+
+<!-- content-guard: allow port-reference -->
+- A running Wazuh manager with API access (default port 55000)
+- Wazuh API credentials (username/password)
+- (Optional) Wazuh Indexer (OpenSearch) access for alert queries
 
 ## MCP Resources
 
@@ -244,11 +441,38 @@ List all rules with level 12 or higher to see critical detection rules
 and their compliance framework mappings.
 ```
 
+## Why not the Wazuh dashboard or the raw API?
+
+- **The Wazuh dashboard** is built for humans clicking through Kibana-style views. It is great for a SOC analyst at a screen, but an AI agent cannot drive it, and it does not turn natural-language questions into the right manager and indexer queries. wazuh-mcp gives the model typed tools instead.
+- **The raw Wazuh REST API + indexer `_search`** can be called directly, but then every agent has to learn JWT auth, the manager-versus-indexer split (alerts and vulnerabilities live in the indexer in Wazuh 4.x), pagination shapes, and which fields are sensitive. wazuh-mcp wraps all of that, validates inputs, caps response size, and sanitizes errors so credentials never leak back to the model.
+- **A general "run any HTTP request" tool** would technically reach Wazuh, but it hands the model your credentials, no input validation, no read-only guarantee, and no redaction of IPs, hashes, or full logs. This server is deliberately read-only and minimizes sensitive output by default.
+- **Writing your own Wazuh MCP shim** is reasonable, and the source here is MIT-licensed if you want to fork it. This one already handles auth refresh, the indexer fallback message, untrusted-content delimiting, transient-error retries, and 28 vetted tools.
+
+## What wazuh-mcp is not
+
+- **Not a write path.** No tool modifies Wazuh state. It cannot restart agents, edit rules, acknowledge alerts, or change configuration. The only writes are JWT authentication and indexer `_search` queries.
+- **Not a replacement for the Wazuh dashboard or SIEM.** It is a query surface for AI clients, not an analyst UI, a data store, or an alerting engine.
+- **Not a hosted service.** It runs locally as a stdio MCP server next to your client. Your Wazuh credentials stay on your machine and in your client's config.
+- **Not a guarantee against prompt injection.** It delimits attacker-influenced SIEM content and warns the model, which reduces risk but does not eliminate it. Treat tool output as data, not instructions.
+- **Not a way to bypass Wazuh access control.** It uses the credentials you give it and can see only what that account can see.
+
+## Documentation and links
+
+- **Website:** [lidless.dev/wazuh-mcp](https://lidless.dev/wazuh-mcp)
+- **npm:** [`wazuh-mcp`](https://www.npmjs.com/package/wazuh-mcp)
+- **Issues:** [github.com/lidless-labs/wazuh-mcp/issues](https://github.com/lidless-labs/wazuh-mcp/issues)
+- **Changelog:** [CHANGELOG.md](CHANGELOG.md)
+- **Security policy:** [SECURITY.md](SECURITY.md)
+- **Contributing:** [CONTRIBUTING.md](CONTRIBUTING.md)
+
 ## Testing
 
 ```bash
-npm test              # Run all tests
-npm run test:watch    # Watch mode
+npm test               # Run all tests
+npm run typecheck      # Type-check TypeScript
+npm audit --omit=dev   # Audit production dependencies
+npm run pack:check     # Verify package contents
+npm run test:watch     # Watch mode
 ```
 
 Tests use mocked Wazuh API responses - no live Wazuh instance needed.
@@ -258,7 +482,9 @@ Tests use mocked Wazuh API responses - no live Wazuh instance needed.
 ```
 wazuh-mcp/
 ├── src/
-│   ├── index.ts           # MCP server entry point
+│   ├── mcp-bin.ts         # MCP server entry point
+│   ├── cli.ts             # wazuhctrl command entry point
+│   ├── mcp-server.ts      # shared MCP server factory
 │   ├── config.ts          # Environment configuration
 │   ├── client.ts          # Wazuh REST API client (JWT auth)
 │   ├── indexer-client.ts  # Wazuh Indexer (OpenSearch) client
@@ -288,4 +514,12 @@ wazuh-mcp/
 
 ## License
 
-MIT
+MIT. See [LICENSE](LICENSE).
+
+---
+
+<p align="center"><a href="https://lidless.dev">Part of <strong>Lidless Labs</strong></a> &middot; the eye does not close</p>
+
+<p align="center"><sub><strong>Security / SOC:</strong> <a href="https://github.com/lidless-labs/soc-stack">soc-stack</a> &middot; <a href="https://github.com/lidless-labs/misp-mcp">misp-mcp</a> &middot; <a href="https://github.com/lidless-labs/suricata-mcp">suricata-mcp</a> &middot; <a href="https://github.com/lidless-labs/thehive-mcp">thehive-mcp</a> &middot; <a href="https://github.com/lidless-labs/cortex-mcp">cortex-mcp</a> &middot; <a href="https://github.com/lidless-labs/mitre-mcp">mitre-mcp</a> &middot; <a href="https://github.com/lidless-labs/zeek-mcp">zeek-mcp</a> &middot; <a href="https://github.com/lidless-labs/hotwash">hotwash</a></sub></p>
+
+<p align="center"><sub><a href="https://lidless.dev">All tools</a> &middot; <a href="https://github.com/lidless-labs">Lidless Labs on GitHub</a></sub></p>