使用说明

用于Claude代码的Kibana MCP服务器

这个仓库提供了完整的设置指南，用于将Kibana与Claude Code集成，使用的是 @tocharian/mcp-server-kibana MCP服务器。

特点/特性

🔍 看起来像是一个放大镜的符号，通常用于表示搜索或查看细节。在中文中，可以简单地描述为“放大镜符号”或“搜索符号”。如果要结合上下文给出更具体的翻译，比如在某个应用或网站中看到这个符号，可以翻译为“搜索按钮”或“查看详情”。但单独来看，最直接的翻译就是“放大镜符号”。 全面的Kibana集成

通过Claude Code全面访问Kibana API
为企业环境提供多空间支持
保存对象管理（仪表板、可视化等）
实时搜索与分析

🛠️（扳手，常用于表示工具或修理） 12款强大工具任您选择

get_status - 检查Kibana服务器健康状况
execute_kb_api 执行自定义的Kibana API请求
search_kibana_api_paths - 发现可用的终端节点
vl_search_saved_objects - 搜索仪表板/可视化工具
vl_get_saved_object - 通过ID获取特定对象
vl_create_saved_object - 创建新对象
vl_update_saved_object - 更新现有对象
vl_bulk_update_saved_objects - 批量更新
vl_bulk_delete_saved_objects - 批量删除
get_available_spaces - 列出 Kibana 空间

快速入门

1. 先决条件

已安装 Claude Code CLI
访问一个 Kibana 实例
有效的认证凭据

2. 配置

将此添加到您的Claude Code MCP配置中：

{
  "mcpServers": {
    "kibana": {
      "command": "npx",
      "args": ["-y", "@tocharian/mcp-server-kibana"],
      "env": {
        "KIBANA_URL": "YOUR_KIBANA_URL",
        "KIBANA_COOKIE": "YOUR_AUTH_COOKIE"
      }
    }
  }
}

3. 环境设置

创建一个 .env 文件：

KIBANA_URL=https://your-kibana-instance.com
KIBANA_COOKIE=security_authentication=your_auth_cookie_here

4. 测试连接

echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | \
KIBANA_URL="$KIBANA_URL" KIBANA_COOKIE="$KIBANA_COOKIE" \
npx -y @tocharian/mcp-server-kibana

配置示例

基本配置

{
  "mcpServers": {
    "kibana": {
      "command": "npx",
      "args": ["-y", "@tocharian/mcp-server-kibana"],
      "env": {
        "KIBANA_URL": "https://localhost:5601",
        "KIBANA_COOKIE": "security_authentication=your_cookie"
      }
    }
  }
}

多空间配置

{
  "mcpServers": {
    "kibana-prod": {
      "command": "npx",
      "args": ["-y", "@tocharian/mcp-server-kibana"],
      "env": {
        "KIBANA_URL": "https://prod-kibana.company.com",
        "KIBANA_COOKIE": "security_authentication=prod_cookie",
        "KIBANA_SPACE": "production"
      }
    },
    "kibana-dev": {
      "command": "npx",
      "args": ["-y", "@tocharian/mcp-server-kibana"],
      "env": {
        "KIBANA_URL": "https://dev-kibana.company.com", 
        "KIBANA_COOKIE": "security_authentication=dev_cookie",
        "KIBANA_SPACE": "development"
      }
    }
  }
}

认证方法

1. Cookie 认证（推荐）

# Extract from browser developer tools
KIBANA_COOKIE="security_authentication=Fe26.2**your_cookie_value_here"

2. API密钥认证

# If your Kibana supports API keys
KIBANA_API_KEY="your_api_key_here"

3. 基本认证

# For basic auth setups
KIBANA_USERNAME="your_username"
KIBANA_PASSWORD="your_password"

使用示例

搜索仪表板

# Find all dashboards with "nginx" in the name
vl_search_saved_objects(
  search="nginx",
  types=["dashboard"],
  fields=["title", "description"],
  perPage=10
)

获取特定仪表板

# Get dashboard by ID
vl_get_saved_object(
  type="dashboard",
  id="your-dashboard-id"
)

执行自定义API

# Get cluster health
execute_kb_api(
  method="GET",
  path="/api/status"
)

在所有空间中搜索

# Search in specific space
vl_search_saved_objects(
  search="logs",
  types=["dashboard", "visualization"],
  space="production"
)

故障排除

常见问题

1. 认证错误

# Check your cookie is still valid
curl -H "Cookie: $KIBANA_COOKIE" "$KIBANA_URL/api/status"

2. 连接超时

# Verify Kibana URL is accessible
curl -I "$KIBANA_URL"

3. 未找到MCP服务器

# Test the MCP server installation
npx -y @tocharian/mcp-server-kibana --help

调试命令

# Test MCP server directly
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | \
KIBANA_URL="$KIBANA_URL" KIBANA_COOKIE="$KIBANA_COOKIE" \
npx -y @tocharian/mcp-server-kibana

# Check available tools
claude mcp

# Test specific tool
# Use Claude Code to test: get_status()

安全最佳实践

1. 环境变量

永远不要将实际凭据提交到git中
使用 .env 在本地文件中
在生产环境中使用安全的凭证管理

2. 认证令牌

定期轮换认证cookie
尽可能使用专用服务帐户
实施适当的访问控制

3. 网络安全

为所有Kibana连接使用HTTPS
对于敏感数据，考虑使用VPN或私有网络
实施适当的防火墙规则

高级配置

自定义包装脚本

创建 kibana-mcp-wrapper.sh:

#!/bin/bash
# Load environment from secure location
source /secure/path/to/kibana.env

# Set additional security headers
export KIBANA_EXTRA_HEADERS='{"X-Custom-Auth": "value"}'

# Run the MCP server
npx -y @tocharian/mcp-server-kibana "$@"

在配置中使用：

{
  "mcpServers": {
    "kibana": {
      "command": "/path/to/kibana-mcp-wrapper.sh"
    }
  }
}

Docker 配置

FROM node:18-alpine

# Install the MCP server
RUN npm install -g @tocharian/mcp-server-kibana

# Set up environment
ENV KIBANA_URL=""
ENV KIBANA_COOKIE=""

# Run the server
CMD ["npx", "@tocharian/mcp-server-kibana"]

贡献

为这个仓库创建分支
创建你的特性分支（git checkout -b feature/amazing-feature)
提交您的更改（git commit -m 'Add amazing feature')
推送到分支（git push origin feature/amazing-feature）
提交一个拉取请求

许可证

这个项目采用MIT许可证授权——详见许可证文件中有详细信息。

致谢

支持

📚 书籍 MCP 文档
💬 “Claude Code Discussions”翻译成中文是“关于Claude代码的讨论”
🐛 蚜虫（或译为小飞虫，具体根据上下文确定）报告问题