Skip to content
Back to search

wazuh-mcp-server

Repo to hold wazuh manager mcp server

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/socfortress--wazuh-mcp-server/badge.svg)](/listings/socfortress--wazuh-mcp-server)

HTML

<a href="/listings/socfortress--wazuh-mcp-server"><img src="/api/listings/socfortress--wazuh-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. Install

From GitHub (Recommended)

python -m venv .venv && source .venv/bin/activate
pip install git+https://github.com/socfortress/wazuh-mcp-server.git

From Release Artifacts

1. Go to the [Releases page](https://github.com/socfortress/wazuh-mcp-server/releases) 2. Download the latest `.whl` file 3. Install with:

pip install wazuh_mcp_server-*.whl

From Build Artifacts (Latest Build)

1. Go to the [Actions tab](https://github.com/socfortress/wazuh-mcp-server/actions) 2. Click on the latest successful workflow run 3. Download the `python-package-distributions` artifact 4. Extract and install:

pip install wazuh_mcp_server-*.whl

2. Configure Environment

Create a `.env` file in your project directory:

# Wazuh Manager Configuration
WAZUH_PROD_URL=https://your-wazuh-manager:55000
WAZUH_PROD_USERNAME=your-username
WAZUH_PROD_PASSWORD=your-password
WAZUH_PROD_SSL_VERIFY=false
WAZUH_PROD_TIMEOUT=30

# MCP Server Configuration
MCP_SERVER_HOST=127.0.0.1
MCP_SERVER_PORT=8000

# Logging Configuration
LOG_LEVEL=INFO

# Tool Filtering (optional)
# WAZUH_DISABLED_TOOLS=DeleteAgentTool,RestartManagerTool
# WAZUH_DISABLED_CATEGORIES=dangerous,write
# WAZUH_READ_ONLY=false

3. Run the Server

# Using the CLI command
wazuh-mcp-server

# Or using the Python module
python -m wazuh_mcp_server

# With custom configuration
wazuh-mcp-server --host 0.0.0.0 --port 8000 --log-level DEBUG

The server will start and be available at `http://127.0.0.1:8000` (or your configured host/port).

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 633 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Wazuh MCP Server
  2. A production-ready **Model Context Protocol (MCP) server** for seamless integration between Wazuh SIEM and Large Language Models (LLMs).
  3. [![Build Status](https://github.com/socfortress/wazuh-mcp-server/actions/workflows/publish.yml/badge.svg)](https://github.com/socfortress/wazuh-mcp-server/actions)
  4. [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
  5. [![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UC4EUQtTxeC8wGrKRafI6pZg)](https://www.youtube.com/@taylorwalton_socfortress/videos)
  6. [![Get in Touch](https://img.shields.io/badge/📧%20Get%20in%20Touch-Friendly%20Support%20Awaits!-blue?style=for-the-badge)](https://www.socfortress.co/contact_form.html)
  7. > **Why?**
  8. > Combine the power of Wazuh's comprehensive security monitoring with the reasoning capabilities of large language models—enabling natural language queries and intelligent analysis of your security data.
  9. ---
  10. ## ✨ Key Features
  11. - 🚀 **Production-ready**: Proper package structure, logging, error handling, and configuration management
  12. - 🔐 **Secure**: JWT token management with automatic refresh
  13. - 🌐 **HTTP/2 Support**: Built on modern async HTTP client with connection pooling
  14. - 📊 **Comprehensive API**: Access Wazuh agents, authentication, and more
  15. - 🎛️ **Configurable**: Environment variables, CLI arguments, and fine-grained tool filtering
  16. - 📦 **Pip installable**: Install directly from GitHub releases or source
  17. ---
  18. ## Table of Contents
  19. - [Quick Start](#quick-start)
  20. - [Installation](#installation)
  21. - [Configuration](#configuration)
  22. - [Usage](#usage)
  23. - [Available Tools](#available-tools)
  24. - [Development](#development)
  25. - [CI/CD](#continuous-integration)
  26. - [Deployment](#deployment)
  27. - [Security](#security-considerations)
  28. - [Contributing](#contributing)
  29. - [License](#license)
  30. ---
  31. ## Quick Start
  32. ### 1. Install
  33. #### From GitHub (Recommended)
  34. ```bash
  35. python -m venv .venv && source .venv/bin/activate
  36. pip install git+https://github.com/socfortress/wazuh-mcp-server.git
  37. ```
  38. #### From Release Artifacts
  39. 1. Go to the [Releases page](https://github.com/socfortress/wazuh-mcp-server/releases)
  40. 2. Download the latest `.whl` file
  41. 3. Install with:
  42. ```bash
  43. pip install wazuh_mcp_server-*.whl
  44. ```
  45. #### From Build Artifacts (Latest Build)
  46. 1. Go to the [Actions tab](https://github.com/socfortress/wazuh-mcp-server/actions)
  47. 2. Click on the latest successful workflow run
  48. 3. Download the `python-package-distributions` artifact
  49. 4. Extract and install:
  50. ```bash
  51. pip install wazuh_mcp_server-*.whl
  52. ```
  53. ### 2. Configure Environment
  54. Create a `.env` file in your project directory:
  55. ```env
  56. # Wazuh Manager Configuration
  57. WAZUH_PROD_URL=https://your-wazuh-manager:55000
  58. WAZUH_PROD_USERNAME=your-username
  59. WAZUH_PROD_PASSWORD=your-password
  60. WAZUH_PROD_SSL_VERIFY=false
  61. WAZUH_PROD_TIMEOUT=30
  62. # MCP Server Configuration
  63. MCP_SERVER_HOST=127.0.0.1
  64. MCP_SERVER_PORT=8000
  65. # Logging Configuration
  66. LOG_LEVEL=INFO
  67. # Tool Filtering (optional)
  68. # WAZUH_DISABLED_TOOLS=DeleteAgentTool,RestartManagerTool
  69. # WAZUH_DISABLED_CATEGORIES=dangerous,write
  70. # WAZUH_READ_ONLY=false
  71. ```
  72. ### 3. Run the Server
  73. ```bash
  74. # Using the CLI command
  75. wazuh-mcp-server
  76. # Or using the Python module
  77. python -m wazuh_mcp_server
  78. # Streamable HTTP for networked clients (requires MCP_AUTH_TOKEN)
  79. MCP_AUTH_TOKEN=$(openssl rand -hex 32) wazuh-mcp-server --transport http --host 0.0.0.0 --port 8000
  80. ```
  81. By default the server speaks MCP over **stdio**, for clients that launch it as a subprocess (`.mcp.json`).
  82. With `--transport http` (or `MCP_TRANSPORT=http`) it serves streamable HTTP at `http://<host>:<port>/mcp`:
  83. - Every request must carry `Authorization: Bearer <MCP_AUTH_TOKEN>`. The server refuses to start in HTTP mode without a token.
  84. - `GET /healthz` is unauthenticated, for container health checks.
  85. Example from Pydantic AI:
  86. ```python
  87. from pydantic_ai.mcp import MCPToolset
  88. wazuh = MCPToolset("http://wazuh-mcp:8000/mcp", id="wazuh", headers={"Authorization": f"Bearer {token}"})
  89. async with wazuh:
  90. agents = await wazuh.direct_call_tool("GetAgentsTool", {"args": {"q": "id=021"}})
  91. ```
  92. ---
  93. ## Installation
  94. ### Requirements
  95. - Python 3.11 or higher
  96. - Access to a Wazuh Manager instance
  97. - Network connectivity to your Wazuh Manager
  98. ### Development Installation
  99. ```bash
  100. git clone https://github.com/socfortress/wazuh-mcp-server.git
  101. cd wazuh-mcp-server
  102. # Create virtual environment
  103. python -m venv .venv
  104. source .venv/bin/activate # On Windows: .venv\Scripts\activate
  105. # Install in development mode
  106. pip install -e ".[dev]"
  107. # Install pre-commit hooks (optional)
  108. pre-commit install
  109. ```
  110. ---
  111. ## Configuration
  112. ### Environment Variables
  113. | Variable | Description | Default | Required |
  114. |----------|-------------|---------|----------|
  115. | `WAZUH_PROD_URL` | Wazuh Manager API URL | None | ✅ |
  116. | `WAZUH_PROD_USERNAME` | Wazuh username | None | ✅ |
  117. | `WAZUH_PROD_PASSWORD` | Wazuh password | None | ✅ |
  118. | `WAZUH_PROD_SSL_VERIFY` | SSL verification | `true` | ❌ |
  119. | `WAZUH_PROD_TIMEOUT` | Request timeout (seconds) | `30` | ❌ |
  120. | `MCP_TRANSPORT` | `stdio` or `http` | `stdio` | ❌ |
  121. | `MCP_SERVER_HOST` | HTTP bind host | `127.0.0.1` | ❌ |
  122. | `MCP_SERVER_PORT` | HTTP port | `8000` | ❌ |
  123. | `MCP_AUTH_TOKEN` | Bearer token for the HTTP transport | None | ✅ for `http` |
  124. | `LOG_LEVEL` | Logging level | `INFO` | ❌ |
  125. | `WAZUH_DISABLED_TOOLS` | Comma-separated list of disabled tools | None | ❌ |
  126. | `WAZUH_DISABLED_CATEGORIES` | Comma-separated list of disabled categories | None | ❌ |
  127. | `WAZUH_READ_ONLY` | Don't register tools that change state on the manager. All current tools only read; new tools must be classified in `TOOL_META`, and unclassified tools count as writes. | `false` | ❌ |
  128. Tool categories for `WAZUH_DISABLED_CATEGORIES`: `auth`, `agents`, `rules`, `sca`.
  129. ### Output and errors
  130. - **Output.** Responses are compact JSON, capped at `MCP_MAX_OUTPUT_CHARS` (default 32000). When a response is too large, whole `affected_items` are dropped and a `truncated` object reports `returned_items`, `original_items`, `total_affected_items` and `original_chars`. Lower `limit`, `select` fewer fields, or page with `offset`.
  131. - **Limits.** List tools default to `limit: 50`.
  132. - **Errors.** Failures, including Wazuh "error": 1 responses, are returned as MCP tool errors (`isError: true`), not as normal text.
  133. ### Docker
  134. ```bash
  135. docker build -t wazuh-mcp-server .
  136. docker run --env-file .env -p 127.0.0.1:8000:8000 wazuh-mcp-server # HTTP on :8000, needs MCP_AUTH_TOKEN
  137. ```
  138. The image runs as a non-root user and has a health check on `/healthz`. Images are published to `ghcr.io/socfortress/wazuh-mcp-server`:
  139. - `main` and `sha-…` on every push to main
  140. - `X.Y.Z` and `X.Y` for `vX.Y.Z` tags
  141. See `CHANGELOG.md`.
  142. ### CLI Options
  143. ```bash
  144. wazuh-mcp-server --help
  145. ```
  146. Available options:
  147. - `--transport`: `stdio` or `http` (default: `MCP_TRANSPORT`, else stdio)
  148. - `--host`: HTTP bind host (default: `MCP_SERVER_HOST`, else 127.0.0.1)
  149. - `--port`: HTTP port (default: `MCP_SERVER_PORT`, else 8000)
  150. - `--log-level`: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  151. - `--wazuh-url`: Wazuh Manager URL (overrides env var)
  152. - `--wazuh-username`: Wazuh username (overrides env var)
  153. - `--wazuh-password`: Wazuh password (overrides env var)
  154. - `--no-ssl-verify`: Disable SSL certificate verification
  155. ---
  156. ## Usage
  157. ### Basic Usage
  158. ```python
  159. from wazuh_mcp_server import Config, create_server
  160. # Create server with environment configuration
  161. config = Config.from_env()
  162. server = create_server(config)
  163. # Start the server
  164. server.start()
  165. ```
  166. ### Custom Configuration
  167. ```python
  168. from wazuh_mcp_server.config import WazuhConfig, ServerConfig, Config
  169. # Create custom configuration
  170. wazuh_config = WazuhConfig(
  171. url="https://your-wazuh-manager:55000",
  172. username="admin",
  173. password="password",
  174. ssl_verify=False
  175. )
  176. server_config = ServerConfig(
  177. host="0.0.0.0",
  178. port=8080,
  179. log_level="DEBUG"
  180. )
  181. config = Config(wazuh=wazuh_config, server=server_config)
  182. server = create_server(config)
  183. ```
  184. ### Integration with LangChain
  185. ```python
  186. import asyncio
  187. from langchain_mcp_adapters.client import MultiServerMCPClient
  188. from langchain_openai import ChatOpenAI
  189. from langchain.agents import AgentType, initialize_agent
  190. async def main():
  191. # Initialize LLM with hardcoded API key
  192. model = ChatOpenAI(
  193. model="gpt-4",
  194. api_key="sk-your-api-key" # <-- replace with your actual key
  195. )
  196. # Connect to Wazuh MCP server
  197. client = MultiServerMCPClient({
  198. "wazuh-mcp-server": {
  199. "transport": "sse",
  200. "url": "http://127.0.0.1:8000/sse/",
  201. }
  202. })
  203. # Get tools and create agent
  204. tools = await client.get_tools()
  205. agent = initialize_agent(
  206. tools=tools,
  207. llm=model,
  208. agent=AgentType.OPENAI_FUNCTIONS,
  209. verbose=True
  210. )
  211. # Query your Wazuh data
  212. response = await agent.ainvoke({
  213. "input": "Show me all active agents and their status"
  214. })
  215. print("Active agents response:")
  216. print(response)
  217. # Get network ports information
  218. ports_response = await agent.ainvoke({
  219. "input": "Show me all listening TCP ports on agent 000"
  220. })
  221. print("Ports response:")
  222. print(ports_response)
  223. if __name__ == "__main__":
  224. asyncio.run(main())
  225. ```
  226. ---
  227. ## Available Tools
  228. The server exposes the following MCP tools:
  229. ### 1. AuthenticateTool
  230. - **Purpose**: Force JWT token refresh from Wazuh Manager
  231. - **Parameters**: None
  232. - **Usage**: Ensures fresh authentication tokens
  233. ### 2. GetAgentsTool
  234. - **Purpose**: Retrieve agents from Wazuh Manager with filtering
  235. - **Parameters**:
  236. - `status` (optional): Filter by agent status (e.g., ["active"])
  237. - `limit` (optional): Maximum number of agents to return (default: 500)
  238. - `offset` (optional): Offset for pagination (default: 0)
  239. ### 3. GetAgentPortsTool
  240. - **Purpose**: Get network ports information from a specific agent using syscollector
  241. - **Parameters**:
  242. - `agent_id` (required): Agent ID to get ports from
  243. - `limit` (optional): Maximum number of ports to return (default: 500)
  244. - `offset` (optional): Offset for pagination (default: 0)
  245. - `protocol` (optional): Filter by protocol (tcp, udp)
  246. - `local_ip` (optional): Filter by local IP address
  247. - `local_port` (optional): Filter by local port
  248. - `remote_ip` (optional): Filter by remote IP address
  249. - `state` (optional): Filter by state (listening, established, etc.)
  250. - `process` (optional): Filter by process name
  251. - `pid` (optional): Filter by process ID
  252. - `tx_queue` (optional): Filter by tx_queue
  253. - `sort` (optional): Sort results by field(s)
  254. - `search` (optional): Search for elements containing the specified string
  255. - `select` (optional): Select which fields to return
  256. - `q` (optional): Query to filter results by
  257. - `distinct` (optional): Look for distinct values
  258. ### 4. GetAgentPackagesTool
  259. - **Purpose**: Get installed packages information from a specific agent using syscollector
  260. - **Parameters**:
  261. - `agent_id` (required): Agent ID to get packages from
  262. - `limit` (optional): Maximum number of packages to return (default: 500)
  263. - `offset` (optional): Offset for pagination (default: 0)
  264. - `vendor` (optional): Filter by package vendor
  265. - `name` (optional): Filter by package name
  266. - `architecture` (optional): Filter by package architecture
  267. - `format` (optional): Filter by package format (e.g., 'deb', 'rpm')
  268. - `version` (optional): Filter by package version
  269. - `sort` (optional): Sort results by field(s)
  270. - `search` (optional): Search for elements containing the specified string
  271. - `select` (optional): Select which fields to return
  272. - `q` (optional): Query to filter results by
  273. - `distinct` (optional): Look for distinct values
  274. ### 5. GetAgentProcessesTool
  275. - **Purpose**: Get running processes information from a specific agent using syscollector
  276. - **Parameters**:
  277. - `agent_id` (required): Agent ID to get processes from
  278. - `limit` (optional): Maximum number of processes to return (default: 500)
  279. - `offset` (optional): Offset for pagination (default: 0)
  280. - `pid` (optional): Filter by process PID
  281. - `state` (optional): Filter by process state
  282. - `ppid` (optional): Filter by process parent PID
  283. - `egroup` (optional): Filter by process egroup
  284. - `euser` (optional): Filter by process euser
  285. - `fgroup` (optional): Filter by process fgroup
  286. - `name` (optional): Filter by process name
  287. - `nlwp` (optional): Filter by process nlwp
  288. - `pgrp` (optional): Filter by process pgrp
  289. - `priority` (optional): Filter by process priority
  290. - `rgroup` (optional): Filter by process rgroup
  291. - `ruser` (optional): Filter by process ruser
  292. - `sgroup` (optional): Filter by process sgroup
  293. - `suser` (optional): Filter by process suser
  294. - `sort` (optional): Sort results by field(s)
  295. - `search` (optional): Search for elements containing the specified string
  296. - `select` (optional): Select which fields to return
  297. - `q` (optional): Query to filter results by
  298. - `distinct` (optional): Look for distinct values
  299. ### 6. ListRulesTool
  300. - **Purpose**: List rules from Wazuh Manager with various filtering options
  301. - **Parameters**:
  302. - `rule_ids` (optional): List of rule IDs to filter by
  303. - `limit` (optional): Maximum number of rules to return (default: 500)
  304. - `offset` (optional): Offset for pagination (default: 0)
  305. - `select` (optional): Select which fields to return
  306. - `sort` (optional): Sort results by field(s)
  307. - `search` (optional): Search for elements containing the specified string
  308. - `q` (optional): Query to filter results by
  309. - `status` (optional): Filter by status (enabled, disabled, all)
  310. - `group` (optional): Filter by rule group
  311. - `level` (optional): Filter by rule level (e.g., '4' or '2-4')
  312. - `filename` (optional): Filter by filename
  313. - `relative_dirname` (optional): Filter by relative directory name
  314. - `pci_dss` (optional): Filter by PCI_DSS requirement
  315. - `gdpr` (optional): Filter by GDPR requirement
  316. - `gpg13` (optional): Filter by GPG13 requirement
  317. - `hipaa` (optional): Filter by HIPAA requirement
  318. - `nist_800_53` (optional): Filter by NIST-800-53 requirement
  319. - `tsc` (optional): Filter by TSC requirement
  320. - `mitre` (optional): Filter by MITRE technique ID
  321. - `distinct` (optional): Look for distinct values
  322. ### 7. GetRuleFileContentTool
  323. - **Purpose**: Get the content of a specific rule file from the ruleset
  324. - **Parameters**:
  325. - `filename` (required): Filename of the rule file to get content from
  326. - `raw` (optional): Format response in plain text (default: false)
  327. - `relative_dirname` (optional): Filter by relative directory name
  328. ### 8. GetRuleFilesTool
  329. - **Purpose**: Get a list of all rule files and their status from Wazuh Manager
  330. - **Parameters**:
  331. - `pretty` (optional): Show results in human-readable format
  332. - `wait_for_complete` (optional): Disable timeout response
  333. - `offset` (optional): First element to return in the collection (default: 0)
  334. - `limit` (optional): Maximum number of elements to return (default: 500)
  335. - `sort` (optional): Sort the collection by a field or fields
  336. - `search` (optional): Look for elements containing the specified string
  337. - `relative_dirname` (optional): Filter by relative directory name
  338. - `filename` (optional): Filter by filename of one or more rule or decoder files
  339. - `status` (optional): Filter by list status (enabled, disabled, all)
  340. - `q` (optional): Query to filter results by
  341. - `select` (optional): Select which fields to return
  342. - `distinct` (optional): Look for distinct values
  343. **Example usage:**
  344. ```python
  345. {"args": {"limit": 10, "status": "enabled"}}
  346. {"args": {"filename": ["0020-syslog_rules.xml"]}}
  347. {"args": {"search": "ruleset"}}
  348. ```
  349. **Returns:**
  350. - JSON list of rule files with their status and directory info
  351. ### 9. GetAgentSCATool
  352. - **Purpose**: Get Security Configuration Assessment (SCA) results for a specific agent
  353. - **Parameters**:
  354. - `agent_id` (required): Agent ID to get SCA results from
  355. - `name` (optional): Filter by policy name
  356. - `description` (optional): Filter by policy description
  357. - `references` (optional): Filter by references
  358. - `limit` (optional): Maximum number of SCA policies to return (default: 500)
  359. - `offset` (optional): Offset for pagination (default: 0)
  360. - `sort` (optional): Sort results by field(s)
  361. - `search` (optional): Search for elements containing the specified string
  362. - `select` (optional): Select which fields to return
  363. - `q` (optional): Query to filter results by
  364. - `distinct` (optional): Look for distinct values
  365. ---
  366. ## Development
  367. ### Setting up Development Environment
  368. ```bash
  369. git clone https://github.com/socfortress/wazuh-mcp-server.git
  370. cd wazuh-mcp-server
  371. # Create virtual environment
  372. python -m venv .venv
  373. source .venv/bin/activate
  374. # Install in development mode with dev dependencies
  375. pip install -e ".[dev]"
  376. # Install pre-commit hooks
  377. pre-commit install
  378. ```
  379. ### Running Tests
  380. ```bash
  381. # Run all tests
  382. pytest
  383. # Run with coverage
  384. pytest --cov=wazuh_mcp_server
  385. # Run specific test file
  386. pytest tests/test_client.py
  387. # Run with verbose output
  388. pytest -v
  389. ```
  390. ### Building the Package
  391. ```bash
  392. # Install build dependencies
  393. pip install build twine
  394. # Build the package
  395. python -m build
  396. # Check the package
  397. twine check dist/*
  398. # Test installation
  399. pip install dist/*.whl
  400. ```
  401. ---
  402. ## Continuous Integration
  403. This project uses GitHub Actions for automated building and testing:
  404. - **Automatic builds**: Every push to `main` and `develop` branches triggers a build
  405. - **Quality assurance**: Comprehensive testing including linting, type checking, and unit tests
  406. - **Artifact publishing**: Built packages are available as GitHub releases and workflow artifacts
  407. ### Creating a Release
  408. 1. Create and push a git tag:
  409. ```bash
  410. git tag v1.0.0
  411. git push origin v1.0.0
  412. ```
  413. 2. The GitHub Action will automatically:
  414. - Build the package
  415. - Run all tests
  416. - Create a GitHub release with downloadable artifacts
  417. ### Installing from CI Artifacts
  418. Visit the [Actions page](https://github.com/socfortress/wazuh-mcp-server/actions) and download the `python-package-distributions` artifact from any successful build.
  419. ---
  420. ## Security Considerations
  421. ### Credentials Management
  422. - **Never commit credentials**: Use environment variables or secrets management
  423. - **Use strong passwords**: Ensure Wazuh credentials are secure
  424. - **Rotate tokens**: Regularly update API credentials
  425. ### Network Security
  426. - **TLS/SSL**: Always use HTTPS in production (`WAZUH_PROD_SSL_VERIFY=true`)
  427. - **Firewall rules**: Restrict access to necessary ports only
  428. - **VPN/Private networks**: Deploy in secured network environments
  429. ### Access Control
  430. - **Least privilege**: Create dedicated Wazuh users with minimal required permissions
  431. - **Read-only mode**: Use `WAZUH_READ_ONLY=true` when write operations aren't needed
  432. - **Tool filtering**: Disable unnecessary tools using `WAZUH_DISABLED_TOOLS`
  433. ### Monitoring
  434. - **Logging**: Enable appropriate log levels for monitoring
  435. - **Health checks**: Implement monitoring of the MCP server endpoint
  436. - **Rate limiting**: Consider implementing rate limiting for production deployments
  437. ---
  438. ## Project Structure
  439. ```
  440. wazuh-mcp-server/
  441. ├── wazuh_mcp_server/ # Main package
  442. │ ├── __init__.py # Package initialization
  443. │ ├── __main__.py # CLI entry point
  444. │ ├── client.py # Wazuh API client
  445. │ ├── config.py # Configuration management
  446. │ ├── server.py # MCP server implementation
  447. │ └── exceptions.py # Custom exceptions
  448. ├── tests/ # Test suite
  449. │ ├── conftest.py # Test configuration
  450. │ ├── test_client.py # Client tests
  451. │ ├── test_config.py # Configuration tests
  452. │ └── test_server.py # Server tests
  453. ├── .github/workflows/ # GitHub Actions
  454. │ └── publish.yml # CI/CD pipeline
  455. ├── requirements.txt # Dependencies
  456. ├── pyproject.toml # Package configuration
  457. ├── .env.example # Environment template
  458. └── README.md # This file
  459. ```
  460. ---
  461. ## Contributing
  462. We welcome contributions! Please follow these steps:
  463. 1. **Fork** the repository
  464. 2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
  465. 3. **Make** your changes and add tests
  466. 4. **Ensure** tests pass: `pytest`
  467. 5. **Check** code quality: `black .`, `isort .`, `flake8 .`
  468. 6. **Commit** your changes (`git commit -m 'Add amazing feature'`)
  469. 7. **Push** to your branch (`git push origin feature/amazing-feature`)
  470. 8. **Open** a Pull Request
  471. ### Development Guidelines
  472. - Write tests for new functionality
  473. - Follow existing code style and patterns
  474. - Update documentation for new features
  475. - Ensure all CI checks pass
  476. ---
  477. ## License
  478. This project is licensed under the GNU Affero General Public License v3.0 only (AGPL-3.0-only) - see the [LICENSE](LICENSE) file for details.
  479. ---
  480. ## Changelog
  481. ### v0.1.0 (Latest)
  482. - Initial release
  483. - Basic MCP server functionality
  484. - Wazuh API integration with JWT authentication
  485. - CLI interface with configuration options
  486. - Docker and Kubernetes deployment support
  487. - Comprehensive test suite
  488. - GitHub Actions CI/CD pipeline
  489. ---
  490. ## Support
  491. - 📖 [Documentation](https://github.com/socfortress/wazuh-mcp-server#readme)
  492. - 🐛 [Issues](https://github.com/socfortress/wazuh-mcp-server/issues)
  493. - 🏢 [SOCFortress](https://socfortress.co)
  494. ---
  495. **Made with ❤️ by SOCFortress**

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.