Consul MCP Server

Consul MCP Server

site icon
2025.04.22 1
TypeScript微服务管理服务网格分析AI 辅助开发开发效率
Consul MCP Server 是一个基于 Model Control Protocol (MCP) 的服务,用于与 HashiCorp Consul 服务发现和服务网格进行交互。它允许用户通过自然语言与 AI 模型(如 Claude)交互,分析微服务架构、创建图表、识别问题并提供建议。
View on GitHub

Overview

基本能力

产品定位

Consul MCP Server 是一个连接 AI 代理与 Consul 基础设施的工具,旨在通过自然语言交互管理和分析微服务架构。

核心功能

  • 列出并分析 Consul 中注册的服务
  • 识别和诊断失败的健康检查
  • 生成服务网格架构图
  • 检测服务连接问题并提供建议
  • 获取关于服务负载均衡和资源利用的 AI 见解

适用场景

  • 微服务架构的分析和管理
  • 服务网格的可视化和问题诊断
  • 通过自然语言交互获取服务状态和建议

工具列表

工具名称 描述
consul/get_services 获取 Consul 中所有服务的列表
consul/get_health_checks 获取健康检查,可选过滤失败检查
consul/get_service_connections 获取服务连接及其状态
consul/create_service_diagram 创建服务关系的 Mermaid 图
consul/analyze_service 分析特定服务以识别问题
consul/get_service_metrics 获取特定服务的详细指标

常见问题解答

  • 如何配置 Consul 连接?.env 文件中设置 CONSUL_HTTP_ADDRCONSUL_HTTP_TOKEN
  • 如何在不同环境中安装? 提供了在 Cursor 和 Claude Desktop 中的详细安装步骤。
  • 如何测试功能? 提供了演示环境的设置脚本和测试场景。

使用教程

使用依赖

  • Node.js 18+
  • npm 或 yarn
  • 运行的 Consul 实例(本地或远程)
  • Claude Desktop 或 Cursor IDE 与 Claude 集成

安装教程

# 克隆仓库
git clone https://github.com/3loka/consul-mcp-server.git
cd consul-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

调试方式

  1. 启动演示环境: bash ./scripts/setup-demo.sh
  2. 启动 MCP 服务器: bash npm start
  3. 连接 Claude Desktop 或 Cursor 到 MCP 服务器
  4. 尝试示例提示,如:
  5. "Show me all services registered in Consul"
  6. "Which services have failing health checks?"
  7. "Create a diagram of my service mesh connections"

许可证

该项目遵循 None 开源许可条款。