minor fixes to the README

This commit is contained in:
Gianluca Brigandi 2025-05-07 11:23:39 -07:00
parent a6a29aba3f
commit 3a34db3c41

View File

@ -153,31 +153,29 @@ Fetches the latest alerts from the configured Wazuh API, transforms them into MC
{ {
"protocol_version": "1.0", "protocol_version": "1.0",
"source": "Wazuh", "source": "Wazuh",
"timestamp": "2023-10-27T10:30:00Z", // ISO 8601 format (RFC3339) "timestamp": "2023-10-27T10:30:00Z",
"event_type": "alert", "event_type": "alert",
"context": { "context": {
"id": "wazuh_alert_id_1", // Wazuh alert ID "id": "wazuh_alert_id_1",
"category": "gdpr", // Derived from rule groups "category": "gdpr",
"severity": "high", // Derived from rule level "severity": "high",
"description": "High severity rule triggered", "description": "High severity rule triggered",
"agent": { // Wazuh agent details "agent": {
"id": "001", "id": "001",
"name": "server-db" "name": "server-db"
}, },
"data": { // Original Wazuh alert data field "data": {
"srcip": "1.2.3.4", "srcip": "1.2.3.4",
"dstport": "22" "dstport": "22"
} }
// Other relevant context fields might be added here
}, },
"metadata": { "metadata": {
"integration": "Wazuh-MCP", "integration": "Wazuh-MCP",
"notes": "Data fetched via Wazuh API" "notes": "Data fetched via Wazuh API"
// Other metadata like Wazuh rule ID could be added
// "rule_id": "1002"
} }
}, },
// ... more MCP messages
] ]
``` ```
- **Error Responses:** - **Error Responses:**
@ -196,7 +194,7 @@ A simple health check endpoint.
{ {
"status": "ok", "status": "ok",
"service": "wazuh-mcp-server", "service": "wazuh-mcp-server",
"timestamp": "2023-10-27T12:00:00Z" // Current server time in ISO 8601 "timestamp": "2023-10-27T12:00:00Z"
} }
``` ```
- **Error Responses:** None expected for this endpoint itself, but the server might be unreachable if down. - **Error Responses:** None expected for this endpoint itself, but the server might be unreachable if down.