kibana-reader-mcp 0.1.0__tar.gz

kibana_reader_mcp-0.1.0/.gitignore

@@ -0,0 +1,71 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class*
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Session files
+session.json
+config.json
+.claude/

kibana_reader_mcp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 yuyangfan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kibana_reader_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: kibana-reader-mcp
+Version: 0.1.0
+Summary: MCP server for reading Kibana pages with DingTalk scan login
+Project-URL: Homepage, https://gitee.com/yuyangfan/kibana-reader-mcp
+Project-URL: Repository, https://gitee.com/yuyangfan/kibana-reader-mcp
+Project-URL: Documentation, https://gitee.com/yuyangfan/kibana-reader-mcp#readme
+Author-email: yuyangfan <yuyangfan@example.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: elasticsearch,kibana,logs,mcp,model-context-protocol
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Kibana Reader MCP
+
+一个用于读取 Kibana 页面内容的 MCP Server，支持钉钉扫码登录。
+
+## 功能
+
+- 读取 Kibana Discover 页面数据
+- 读取 Kibana Dashboard 页面数据
+- 支持短 URL 自动重定向
+- 自动管理 Cookie/Session
+- 支持钉钉扫码认证
+
+## 安装
+
+```bash
+pip install kibana-reader-mcp
+playwright install chromium
+```
+
+## 配置
+
+### 方式一：配置文件
+
+创建配置文件 `~/.kibana-reader-mcp/config.json`：
+
+```json
+{
+    "kibana_base_url": "https://your-kibana.example.com",
+    "session_file": "~/.kibana-reader-mcp/session.json",
+    "playwright_headless": false,
+    "scan_timeout_seconds": 120,
+    "default_max_rows": 100
+}
+```
+
+### 方式二：环境变量
+
+```bash
+export KIBANA_BASE_URL="https://your-kibana.example.com"
+export PLAYWRIGHT_HEADLESS=false
+export SCAN_TIMEOUT_SECONDS=120
+```
+
+## 客户端配置
+
+### Claude Desktop
+
+编辑 `~/Library/Application Support/Claude/claude_desktop_config.json`：
+
+```json
+{
+    "mcpServers": {
+        "kibana-reader": {
+            "command": "uvx",
+            "args": ["kibana-reader-mcp"],
+            "env": {
+                "KIBANA_BASE_URL": "https://your-kibana.example.com"
+            }
+        }
+    }
+}
+```
+
+### Claude Code
+
+编辑 `~/.claude/settings.json`：
+
+```json
+{
+    "mcpServers": {
+        "kibana-reader": {
+            "command": "uvx",
+            "args": ["kibana-reader-mcp"],
+            "env": {
+                "KIBANA_BASE_URL": "https://your-kibana.example.com"
+            }
+        }
+    }
+}
+```
+
+### Cursor / Windsurf / Codex
+
+在 MCP 设置中添加服务器配置，格式同上。
+
+## 使用示例
+
+```
+AI: 调用 read_kibana_url
+参数:
+- url: "https://your-kibana/goto/abc123"
+- max_rows: 100
+
+返回: Kibana 页面的结构化数据
+```
+
+## 认证流程
+
+1. 首次使用时，MCP 会打开浏览器显示钉钉扫码页面
+2. 用户扫码登录后，MCP 自动保存 Cookie
+3. 后续调用直接使用保存的 Cookie
+4. Cookie 过期时自动提示重新扫码
+
+## URL 类型支持
+
+| 类型 | 示例 | 处理方式 |
+|------|------|---------|
+| 短 URL | `/goto/abc123` | Playwright 重定向 |
+| Discover | `/app/kibana#/discover` | API 调用 |
+| Dashboard | `/app/kibana#/dashboard` | API 调用 |
+
+## 开发
+
+```bash
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest
+```
+
+## License
+
+MIT

kibana_reader_mcp-0.1.0/README.md

@@ -0,0 +1,124 @@
+# Kibana Reader MCP
+
+一个用于读取 Kibana 页面内容的 MCP Server，支持钉钉扫码登录。
+
+## 功能
+
+- 读取 Kibana Discover 页面数据
+- 读取 Kibana Dashboard 页面数据
+- 支持短 URL 自动重定向
+- 自动管理 Cookie/Session
+- 支持钉钉扫码认证
+
+## 安装
+
+```bash
+pip install kibana-reader-mcp
+playwright install chromium
+```
+
+## 配置
+
+### 方式一：配置文件
+
+创建配置文件 `~/.kibana-reader-mcp/config.json`：
+
+```json
+{
+    "kibana_base_url": "https://your-kibana.example.com",
+    "session_file": "~/.kibana-reader-mcp/session.json",
+    "playwright_headless": false,
+    "scan_timeout_seconds": 120,
+    "default_max_rows": 100
+}
+```
+
+### 方式二：环境变量
+
+```bash
+export KIBANA_BASE_URL="https://your-kibana.example.com"
+export PLAYWRIGHT_HEADLESS=false
+export SCAN_TIMEOUT_SECONDS=120
+```
+
+## 客户端配置
+
+### Claude Desktop
+
+编辑 `~/Library/Application Support/Claude/claude_desktop_config.json`：
+
+```json
+{
+    "mcpServers": {
+        "kibana-reader": {
+            "command": "uvx",
+            "args": ["kibana-reader-mcp"],
+            "env": {
+                "KIBANA_BASE_URL": "https://your-kibana.example.com"
+            }
+        }
+    }
+}
+```
+
+### Claude Code
+
+编辑 `~/.claude/settings.json`：
+
+```json
+{
+    "mcpServers": {
+        "kibana-reader": {
+            "command": "uvx",
+            "args": ["kibana-reader-mcp"],
+            "env": {
+                "KIBANA_BASE_URL": "https://your-kibana.example.com"
+            }
+        }
+    }
+}
+```
+
+### Cursor / Windsurf / Codex
+
+在 MCP 设置中添加服务器配置，格式同上。
+
+## 使用示例
+
+```
+AI: 调用 read_kibana_url
+参数:
+- url: "https://your-kibana/goto/abc123"
+- max_rows: 100
+
+返回: Kibana 页面的结构化数据
+```
+
+## 认证流程
+
+1. 首次使用时，MCP 会打开浏览器显示钉钉扫码页面
+2. 用户扫码登录后，MCP 自动保存 Cookie
+3. 后续调用直接使用保存的 Cookie
+4. Cookie 过期时自动提示重新扫码
+
+## URL 类型支持
+
+| 类型 | 示例 | 处理方式 |
+|------|------|---------|
+| 短 URL | `/goto/abc123` | Playwright 重定向 |
+| Discover | `/app/kibana#/discover` | API 调用 |
+| Dashboard | `/app/kibana#/dashboard` | API 调用 |
+
+## 开发
+
+```bash
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest
+```
+
+## License
+
+MIT

kibana_reader_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "kibana-reader-mcp"
+version = "0.1.0"
+description = "MCP server for reading Kibana pages with DingTalk scan login"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "yuyangfan", email = "yuyangfan@example.com" }
+]
+keywords = ["mcp", "kibana", "elasticsearch", "logs", "model-context-protocol"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "mcp>=1.0.0",
+    "playwright>=1.40.0",
+    "httpx>=0.27.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+]
+
+[project.scripts]
+kibana-reader-mcp = "kibana_reader_mcp.server:run"
+
+[project.urls]
+Homepage = "https://gitee.com/yuyangfan/kibana-reader-mcp"
+Repository = "https://gitee.com/yuyangfan/kibana-reader-mcp"
+Documentation = "https://gitee.com/yuyangfan/kibana-reader-mcp#readme"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/kibana_reader_mcp"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/kibana_reader_mcp/",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

kibana_reader_mcp-0.1.0/src/kibana_reader_mcp/__init__.py

@@ -0,0 +1,3 @@
+"""Kibana Reader MCP - A MCP server for reading Kibana page content."""
+
+__version__ = "0.1.0"

kibana_reader_mcp-0.1.0/src/kibana_reader_mcp/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for running the MCP server via python -m kibana_reader_mcp."""
+
+from .server import run
+
+if __name__ == "__main__":
+    run()

kibana_reader_mcp-0.1.0/src/kibana_reader_mcp/auth.py

@@ -0,0 +1,196 @@
+"""Authentication management for Kibana with DingTalk scan login."""
+
+import json
+import time
+from pathlib import Path
+from typing import Optional
+
+import httpx
+from playwright.async_api import async_playwright, Browser, Page
+
+from .config import Config, get_session_path, ensure_config_dir
+
+
+class SessionData:
+    """Session 数据模型"""
+
+    cookies: dict
+    created_at: float
+    expires_at: Optional[float] = None
+
+    def __init__(self, cookies: dict, created_at: float = None):
+        self.cookies = cookies
+        self.created_at = created_at or time.time()
+        self.expires_at = None
+
+    def is_expired(self, max_age_seconds: int = 3600 *24) -> bool:
+        """检查 Session 是否过期"""
+        if self.expires_at:
+            return time.time() > self.expires_at
+        # 默认24小时过期
+        return time.time() > self.created_at + max_age_seconds
+
+    def to_dict(self) -> dict:
+        return {
+            "cookies": self.cookies,
+            "created_at": self.created_at,
+            "expires_at": self.expires_at,
+        }
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "SessionData":
+        return cls(
+            cookies=data.get("cookies", {}),
+            created_at=data.get("created_at"),
+        )
+
+
+class AuthManager:
+    """认证管理器"""
+
+    def __init__(self, config: Config):
+        self.config = config
+        self.session: Optional[SessionData] = None
+        self._browser: Optional[Browser] = None
+
+    def load_session(self) -> Optional[SessionData]:
+        """从文件加载 Session"""
+        session_path = get_session_path(self.config)
+
+        if session_path.exists():
+            try:
+                with open(session_path, "r") as f:
+                    data = json.load(f)
+                self.session = SessionData.from_dict(data)
+                return self.session
+            except Exception:
+                return None
+        return None
+
+    def save_session(self):
+        """保存 Session 到文件"""
+        ensure_config_dir()
+        session_path = get_session_path(self.config)
+
+        if self.session:
+            with open(session_path, "w") as f:
+                json.dump(self.session.to_dict(), f)
+
+    async def ensure_authenticated(self) -> dict:
+        """确保已认证，返回有效的 cookies"""
+        # 检查是否有有效 Session
+        if self.session and not self.session.is_expired():
+            return self.session.cookies
+
+        # 尝试加载已保存的 Session
+        loaded = self.load_session()
+        if loaded and not loaded.is_expired():
+            self.session = loaded
+            return self.session.cookies
+
+        # 需要重新登录（扫码）
+        cookies = await self._login_with_scan()
+        self.session = SessionData(cookies)
+        self.save_session()
+        return cookies
+
+    async def _login_with_scan(self) -> dict:
+        """使用钉钉扫码登录"""
+        login_url = f"{self.config.kibana_base_url}/login"
+
+        async with async_playwright() as p:
+            browser = await p.chromium.launch(
+                headless=self.config.playwright_headless
+            )
+            page = await browser.new_page()
+
+            # 打开登录页
+            await page.goto(login_url)
+            print(f"请在浏览器中扫码登录: {login_url}")
+            print("等待扫码...")
+
+            # 等待登录成功（检测页面跳转或特定元素）
+            timeout = self.config.scan_timeout_seconds * 1000
+
+            try:
+                # 等待登录成功后的页面变化
+                await page.wait_for_url("**/app/kibana**", timeout=timeout)
+                print("登录成功！")
+
+                # 提取 cookies
+                cookies = {}
+                for cookie in await page.context.cookies():
+                    cookies[cookie["name"]] = cookie["value"]
+
+                await browser.close()
+                return cookies
+
+            except Exception as e:
+                await browser.close()
+                raise Exception(f"扫码登录超时或失败: {e}")
+
+    async def resolve_short_url(self, short_url: str) -> str:
+        """使用浏览器解析短 URL 重定向"""
+        async with async_playwright() as p:
+            browser = await p.chromium.launch(
+                headless=self.config.playwright_headless
+            )
+            context = await browser.new_context()
+
+            # 设置 cookies
+            if self.session:
+                cookies_list = []
+                for name, value in self.session.cookies.items():
+                    cookies_list.append({
+                        "name": name,
+                        "value": value,
+                        "domain": self.config.kibana_base_url.split("//")[1].split("/")[0],
+                        "path": "/"
+                    })
+                await context.add_cookies(cookies_list)
+
+            page = await context.new_page()
+
+            # 用于捕获 _msearch 请求
+            captured_request = None
+
+            async def capture_request(request):
+                if "_msearch" in request.url:
+                    try:
+                        body = request.post_data
+                        if body:
+                            captured_request = body
+                    except:
+                        pass
+
+            page.on("request", capture_request)
+
+            try:
+                # 访问短 URL，设置超时
+                await page.goto(short_url, timeout=30000, wait_until="domcontentloaded")
+
+                # 等待 URL 变化（短 URL 重定向）
+                await page.wait_for_url("**/app/kibana**", timeout=15000)
+
+                # 等待 _msearch 请求完成
+                await page.wait_for_timeout(2000)
+
+                # 获取最终 URL
+                final_url = page.url
+
+                await browser.close()
+                return final_url, captured_request
+
+            except Exception as e:
+                await browser.close()
+                # 如果解析失败，返回原始 URL
+                return short_url, None
+
+    def get_http_client(self) -> httpx.AsyncClient:
+        """获取带认证的 HTTP 客户端"""
+        cookies = self.session.cookies if self.session else {}
+        return httpx.AsyncClient(
+            base_url=self.config.kibana_base_url,
+            cookies=cookies,
+            timeout=30.0,
+        )