OpenSearch MCP Server

OpenSearch MCP Server

site icon
2025.03.24 0
JavaScript安全日志分析事件调查趋势分析开发效率数据库
OpenSearch MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,专门用于查询和分析存储在 OpenSearch 中的 Wazuh 安全日志。该服务提供了强大的搜索、统计和可视化功能,帮助用户高效地管理和分析安全日志数据。
View on GitHub

Overview

基本能力

产品定位

OpenSearch MCP Server 是一个用于查询和分析 Wazuh 安全日志的工具,旨在提供高效的日志管理和分析能力。

核心功能

  • 高级过滤搜索:支持通过高级查询条件搜索安全警报。
  • 警报详情获取:提供特定警报的详细信息。
  • 安全事件统计:生成安全事件的统计数据。
  • 警报趋势可视化:可视化展示警报随时间的变化趋势。
  • 进度报告:支持长时间运行的操作进度报告。
  • 结构化错误处理:提供清晰的错误信息反馈。

适用场景

  • 安全日志分析:用于分析和监控 Wazuh 安全日志。
  • 事件调查:帮助快速定位和调查安全事件。
  • 趋势分析:可视化展示安全警报的趋势变化。

工具列表

  1. Search Alerts:搜索 Wazuh 数据中的安全警报。
  2. 参数:query(查询文本)、timeRange(时间范围)、maxResults(最大结果数)、index(索引模式)。
  3. Get Alert Details:获取特定警报的详细信息。
  4. 参数:id(警报ID)、index(索引模式)。
  5. Alert Statistics:获取安全警报的统计数据。
  6. 参数:timeRange(时间范围)、field(聚合字段)、index(索引模式)。
  7. Visualize Alert Trend:可视化警报趋势。
  8. 参数:timeRange(时间范围)、interval(时间间隔)、query(查询条件)、index(索引模式)。

常见问题解答

  • 如何启用调试模式?:使用 npm run stdio:debug 命令启动调试模式。
  • 如何测试工具?:使用 npm run devnpm run inspect 命令进行测试。

使用教程

使用依赖

  • Node.js v16 或更高版本:确保已安装 Node.js。
  • OpenSearch 实例:需要有访问包含 Wazuh 安全日志的 OpenSearch 实例的权限。

安装教程

选项1:使用 npx 直接从 GitHub 运行(推荐)

npx github:jetbalsa/mcp-opensearch-js

选项2:本地安装

  1. 克隆仓库:
git clone https://github.com/jetbalsa/mcp-opensearch-js.git
cd mcp-opensearch-js
  1. 安装依赖:
npm install
  1. 配置环境变量:
cp .env.example .env
  1. 编辑 .env 文件,填写 OpenSearch 连接信息。

调试方式

  • 启动服务器
npm start
  • 启用调试日志
npm run stdio:debug
  • 使用 MCP CLI 测试
npm run dev
  • 使用 MCP Inspector 测试
npm run inspect

许可证

该项目遵循 MIT 开源许可条款。