返回 MCP 目录
public公开dns本地运行

emqx-plugin-mcp-tools

一个提供MCP工具和资源的EMQX插件,用于健康检查和问题分析

article

README

🚀 emqx_mcp_tools

emqx_mcp_tools 是一款 EMQX 插件,它提供了一些 MCP 工具和资源,可用于健康检查和问题分析。

🚀 快速开始

本插件提供了一系列 MCP 工具和资源,能帮助你对 EMQX 进行健康检查和问题分析。按照以下步骤安装和配置插件,即可开始使用。

✨ 主要特性

  • 部分 EMQX API 的 MCP 包装器:为 EMQX API 提供了一组 MCP 包装器,便于进行健康检查和问题分析,例如获取集群状态、获取连接器、认证器和授权源的相关信息。
  • 网络工具:提供了一些网络工具,可帮助你检查网络状态,例如从 EMQX 节点检查与主机的连接性。

📦 安装指南

  1. 发布页面 下载插件。
  2. 将插件复制到 EMQX 插件目录。如果你使用二进制包安装 EMQX,插件目录通常位于 /var/lib/emqx/plugins/;如果你使用 zip 包安装 EMQX,插件目录则为 <PATH>/<TO>/<EMQX DIR>/plugins/
  3. 运行以下命令安装并启动插件:
./bin/emqx ctl plugins install emqx_mcp_tools-<VSN>
./bin/emqx ctl plugins start emqx_mcp_tools-<VSN>

其中,<VSN> 是你下载的插件版本。

📚 详细文档

你可以在 EMQX 仪表盘上更改插件配置。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端