kibana-mcp

🚀 Kibana - MCP 服务器文档

Kibana - MCP 服务器文档为你提供该服务器的安装、构建、发布以及开发测试等方面的详细指导，帮助你快速上手和使用。

🚀 快速开始

你可以按照下面的步骤来完成 Kibana - MCP 服务器的安装、构建、发布以及开发测试等操作。

📦 安装指南

使用 uv 同步依赖：

uv sync

🚀 构建和发布

准备发行版本：

1. 构建软件包分布：

   uv build
   

   这将在 dist/ 目录中创建源代码和轮分布。
2. 发布到 PyPI：

   uv publish
   

   ⚠️ 重要提示：需要配置 PyPI 凭证。

💻 使用示例

开发环境与测试

依赖项

安装开发依赖项：

pip install -r requirements-dev.txt

快速开始脚本

从项目根目录运行快速启动脚本：

./testing/quickstart-test-env.sh

该脚本 (testing/main.py) 将执行以下操作：

1. 检查 Docker 及 Docker Compose。
2. 解析 testing/docker-compose.yml 配置。
3. 运行 docker compose up -d。
4. 等待 Elasticsearch 和 Kibana API 起来。
5. 创建用于 Kibana 内部使用的自定义用户 (kibana_system_user) 和角色。
6. 创建索引模板 (mcp_auth_logs_template)。
7. 读取 testing/sample_rule.json（一个检测规则）并发送 POST 请求到 http://localhost:5601/api/detection_engine/rules 创建规则。
8. 写入 testing/auth_events.ndjson 样例数据到 mcp-auth-logs-default 索引。
9. 检查 http://localhost:5601/api/detection_engine/signals/search 上的检测信号。
10. 打印状态、URL、凭证和关闭命令。

停止测试环境

• 运行脚本打印的关闭命令（例如，docker compose -f testing/docker-compose.yml down）。使用 -v 标志 (down -v) 来移除数据卷。