返回市场
米卡维多利亚指标

米卡维多利亚指标

作者:VictoriaMetrics-Community90 星标更新:2025-11-17

项目介绍

<img width="25" height="25" alt="vm-community-icon" src="https://gips1.baidu.com/it/u=3358645256,3965204775&fm=3081&app=3081&f=PNG?w=200&h=200" /> VictoriaMetrics MCP Server

最新版本 信任评分 smithery 徽章 许可证 Slack X Reddit

这是用于 VictoriaMetricsModel Context Protocol (MCP) 服务器实现。

它提供了对您的 VictoriaMetrics 实例的访问,并与 VictoriaMetrics API文档 进行无缝集成。它可以为您提供一个全面的界面,用于监控、可观测性和调试任务,使工程师和工具能够进行高级自动化和交互操作。

功能

此 MCP 服务器允许您使用 VictoriaMetrics 几乎所有的只读 API,即在 VMUI 中可用的所有功能:

  • 查询指标并探索数据(如果客户端支持,还可以绘制图表)
  • 列出和导出可用的指标、标签、标签值和整个系列
  • 分析和测试您的警报和记录规则及警报
  • 显示您的 VictoriaMetrics 实例参数
  • 探索数据和指标使用统计信息的基数
  • 分析、跟踪、美化和解释您的查询
  • 调试您的重新标记规则、降采样和保留策略配置
  • VictoriaMetrics Cloud 集成

此外,MCP 服务器包含嵌入式最新的文档,并且可以在没有在线访问的情况下搜索这些文档。

有关确切可用工具和提示的更多详细信息,请参阅 使用 部分。

您可以结合工具的功能和文档搜索功能来创建针对您的 VictoriaMetrics 实例的出色使用场景。 只需查看 对话示例 部分即可了解其工作方式。 请注意,MCP 服务器及其响应的质量非常依赖于您的客户端的能力以及您所使用的模型的质量。

您还可以将 MCP 服务器与其他可观测性或文档搜索相关的 MCP 服务器结合使用,以获得更强大的结果。

无需安装即可尝试

有一个公开可用的 VictoriaMetrics MCP 服务器实例,您可以在不安装的情况下测试其功能:

https://play-mcp.victoriametrics.com/mcp

注意! 此 URL 不应通过浏览器打开,而是应在 MCP 客户端中使用。

它在 流式 HTTP 模式下可用,并配置为与 公共 VictoriaMetrics 演示环境一起工作。

以下是 Claude Desktop 的配置示例:

image

要求

安装

Go

go install github.com/VictoriaMetrics-Community/mcp-victoriametrics/cmd/mcp-victoriametrics@latest

二进制文件

只需从 发布页面 下载最新版本并将其放置在您的 PATH 中。

Linux x86_64 示例(请注意其他架构和平台也提供):

latest=$(curl -s https://api.github.com/repos/VictoriaMetrics-Community/mcp-victoriametrics/releases/latest | grep 'tag_name' | cut -d\" -f4)
wget https://github.com/VictoriaMetrics-Community/mcp-victoriametrics/releases/download/$latest/mcp-victoriametrics_Linux_x86_64.tar.gz
tar axvf mcp-victoriametrics_Linux_x86_64.tar.gz

Docker

您可以使用 Docker 运行 VictoriaMetrics MCP 服务器。

这是最简单的入门方法,无需安装 Go 或从源代码构建。

docker run -d --name mcp-victoriametrics \
  -e VM_INSTANCE_ENTRYPOINT=https://play.victoriametrics.com \
  -e VM_INSTANCE_TYPE=cluster \
  -e MCP_SERVER_MODE=sse \
  -e MCP_LISTEN_ADDR=:8080 \
  -p 8080:8080 \
  ghcr.io/victoriametrics-community/mcp-victoriametrics

您应该替换环境变量以使用自己的参数。

请注意,MCP_SERVER_MODE=http 标志用于启用流式 HTTP 模式。 有关服务器模式的更多详细信息,请参阅 配置 部分。

请参阅 GitHub 注册表中的可用 Docker 镜像。

有关使用 Docker 与 MCP 服务器和标准输入输出模式下的客户端的更多详细信息,请参阅 使用 Docker 而不是二进制文件部分。

源代码

要从源代码构建二进制文件,可以使用以下方法:

  • 克隆仓库:

    git clone https://github.com/VictoriaMetrics-Community/mcp-victoriametrics.git
    cd mcp-victoriametrics
    
  • 从克隆的源代码构建二进制文件:

    make build
    # 然后您可以在 PATH 中找到二进制文件 mcp-victoriametrics 或直接运行
    
  • 从克隆的源代码构建镜像:

    docker build -t mcp-victoriametrics .
    # 然后您可以使用 docker 镜像 mcp-victoriametrics 来运行或推送
    

Smithery

要通过 Smithery 自动安装 VictoriaMetrics MCP 服务器,您可以使用以下命令:

# 获取支持的 MCP 客户端列表
npx -y @smithery/cli list clients
# 可用客户端:
#  claude
#  cline
#  windsurf
#  roocode
#  witsy
#  enconvo
#  cursor
#  vscode
#  vscode-insiders
#  boltai
#  amazon-bedrock

# 为您的客户端安装 VictoriaMetrics MCP 服务器
npx -y @smithery/cli install @VictoriaMetrics-Community/mcp-victoriametrics --client <YOUR-CLIENT-NAME>
# 并按照说明操作

配置

VictoriaMetrics 的 MCP 服务器通过环境变量进行配置:

变量描述必需默认值允许的值
VM_INSTANCE_ENTRYPOINT / VMC_API_KEYVictoriaMetrics 实例的 URL(应该是 vmsingle 或 vmselect 的根 / URL)是(如果您不使用 VMC_API_KEY--
VM_INSTANCE_TYPEVictoriaMetrics 实例的类型是(如果您不使用 VMC_API_KEY-single, cluster
VM_INSTANCE_BEARER_TOKENVictoriaMetrics API 的身份验证令牌--
VM_INSTANCE_HEADERS发送请求时自定义的 HTTP 头(逗号分隔的键值对)--
VMC_API_KEY来自 VictoriaMetrics Cloud 控制台的 API 密钥--
MCP_SERVER_MODE服务器操作模式。详情见 模式stdiostdio, sse, http
MCP_LISTEN_ADDRSSE 或 HTTP 服务器监听的地址localhost:8080-
MCP_DISABLED_TOOLS要禁用的工具的逗号分隔列表--
MCP_DISABLE_RESOURCES禁用所有资源(文档工具将继续工作)falsefalse, true
MCP_HEARTBEAT_INTERVAL定义流式 HTTP 协议的心跳间隔。这意味着 MCP 服务器将通过 GET 连接向客户端发送心跳,以防止网络基础设施(如网关)关闭连接。30s-

您可以使用两种选项连接到您的 VictoriaMetrics 实例:

  • 使用 VM_INSTANCE_ENTRYPOINT + VM_INSTANCE_TYPE + VM_INSTANCE_BEARER_TOKEN(可选)环境变量连接到任何单节点或集群实例的 VictoriaMetrics。
  • 使用 VMC_API_KEY 环境变量与您的 VictoriaMetrics Cloud 实例一起工作。

模式

MCP 服务器支持以下操作模式(传输):

  • stdio - 标准输入/输出模式,其中服务器从标准输入读取命令并向标准输出写入响应。这是默认模式,适用于本地服务器。
  • sse - 服务器发送事件。服务器将暴露 /sse/message 端点以供 SSE 连接使用。
  • http - 流式 HTTP。服务器将暴露 /mcp 端点以供 HTTP 连接使用。

有关传输的更多信息,请参阅 MCP 文档:

配置示例

# 对于单节点实例
export VM_INSTANCE_ENTRYPOINT="http://localhost:8428"
export VM_INSTANCE_TYPE="single"
export VM_INSTANCE_BEARER_TOKEN="your-token"

# 对于集群
export VM_INSTANCE_ENTRYPOINT="https://play.victoriametrics.com"
export VM_INSTANCE_TYPE="cluster"
export MCP_DISABLED_TOOLS="export,metric_statistics,test_rules" # 禁用导出、统计和规则单元测试工具

# 对于 VictoriaMetrics Cloud
export VMC_API_KEY="<you-api-key>"

# 服务器模式
export MCP_SERVER_MODE="sse"
export MCP_LISTEN_ADDR="0.0.0.0:8080"

# 身份验证的自定义头(例如,在反向代理后面)
# 预期语法是逗号分隔的键值对
export VM_INSTANCE_HEADERS="<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"

端点

在 SSE 和 HTTP 模式下,MCP 服务器提供以下端点:

端点描述
/sse + /messageSSE 模式的消息端点(适用于支持 SSE 的 MCP 客户端)
/mcpHTTP 模式的流式消息端点(适用于支持流式 HTTP 的 MCP 客户端)
/metrics用于监控 MCP 服务器的 Prometheus 格式的指标
/health/liveness确保服务器正在运行的存活检查端点
/health/readiness确保服务器准备好接受请求的就绪检查端点

在客户端设置

Cursor

转到:设置 -> Cursor 设置 -> MCP -> 添加新的全局 MCP 服务器,并将以下配置粘贴到您的 Cursor ~/.cursor/mcp.json 文件中:

{
  "mcpServers": {
    "victoriametrics": {
      "command": "/path/to/mcp-victoriametrics",
      "env": {
        "VM_INSTANCE_ENTRYPOINT": "<YOUR_VM_INSTANCE>",
        "VM_INSTANCE_TYPE": "<YOUR_VM_INSTANCE_TYPE>",
        "VM_INSTANCE_BEARER_TOKEN": "<YOUR_VM_BEARER_TOKEN>",
        "VM_INSTANCE_HEADERS": "<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"
      }
    }
  }
}

请参阅 Cursor MCP 文档获取更多信息。

Claude Desktop

将以下内容添加到您的 Claude Desktop claude_desktop_config.json 文件中(您可以在打开 设置 -> 开发者 -> 编辑配置 时找到它):

{
  "mcpServers": {
    "victoriametrics": {
      "command": "/path/to/mcp-victoriametrics",
      "env": {
        "VM_INSTANCE_ENTRYPOINT": "<YOUR_VM_INSTANCE>",
        "VM_INSTANCE_TYPE": "<YOUR_VM_INSTANCE_TYPE>",
        "VM_INSTANCE_BEARER_TOKEN": "<YOUR_VM_BEARER_TOKEN>",
        "VM_INSTANCE_HEADERS": "<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"
      }
    }
  }
}

请参阅 Claude Desktop MCP 文档获取更多信息。

Claude Code

运行以下命令:

claude mcp add victoriametrics -- /path/to/mcp-victoriametrics \
  -e VM_INSTANCE_ENTRYPOINT=<YOUR_VM_INSTANCE> \
  -e VM_INSTANCE_TYPE=<YOUR_VM_INSTANCE_TYPE>
  -e VM_INSTANCE_BEARER_TOKEN=<YOUR_VM_BEARER_TOKEN>
  -e VM_INSTANCE_HEADERS="<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"

请参阅 Claude Code MCP 文档获取更多信息。

Visual Studio Code

将以下内容添加到您的 VS Code MCP 配置文件中:

{
  "servers": {
    "victoriametrics": {
      "type": "stdio",
      "command": "/path/to/mcp-victoriametrics",
      "env": {
        "VM_INSTANCE_ENTRYPOINT": "<YOUR_VM_INSTANCE>",
        "VM_INSTANCE_TYPE": "<YOUR_VM_INSTANCE_TYPE>",
        "VM_INSTANCE_BEARER_TOKEN": "<YOUR_VM_BEARER_TOKEN>",
        "VM_INSTANCE_HEADERS": "<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"
      }
    }
  }
}

请参阅 VS Code MCP 文档获取更多信息。

Zed

将以下内容添加到您的 Zed 配置文件中:

  "context_servers": {
    "victoriametrics": {
      "command": {
        "path": "/path/to/mcp-victoriametrics",
        "args": [],
        "env": {
          "VM_INSTANCE_ENTRYPOINT": "<YOUR_VM_INSTANCE>",
          "VM_INSTANCE_TYPE": "<YOUR_VM_INSTANCE_TYPE>",
          "VM_INSTANCE_BEARER_TOKEN": "<YOUR_VM_BEARER_TOKEN>",
          "VM_INSTANCE_HEADERS": "<HEADER>=<HEADER_VALUE>,<HEADER>=<HEADER_VALUE>"
        }
      },
      "settings": {}
    }
  }

请参阅 Zed MCP 文档获取更多信息。

JetBrains IDEs

  • 打开 设置 -> 工具 -> AI 助手 -> `模型