JinDaGe - consul-mcp-server MCP Details

article

README

🚀 Consul MCP 服务端

Consul MCP 服务端是一个用于与 HashiCorp Consul 服务发现和服务网格交互的模型控制协议（MCP）服务器。它遵循 Anthropic 的 MCP 规范，允许 Claude 通过自然语言交互，分析您的微服务架构、创建图表、识别问题并提供建议。

🚀 快速开始

什么是模型控制协议？

模型控制协议 (MCP) 是由 Anthropic 发布的一项规范，使 AI 模型（如 Claude）能够与外部工具和 API 交互。此实现将 AI 代理连接到您的 Consul 基础设施，允许您通过自然语言管理和服务分析。

✨ 主要特性

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

📦 安装指南

要求

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

配置

在根目录下创建一个 .env 文件，包含以下变量：

CONSUL_HTTP_ADDR=http://localhost:8500
CONSUL_HTTP_TOKEN=your-consul-token
PORT=3000
USE_HTTP=true

CONSUL_HTTP_ADDR：Consul 服务器地址
CONSUL_HTTP_TOKEN：Consul 服务器的 ACL 令牌
PORT：HTTP 服务器端口
USE_HTTP：设置为 "true" 表示启用 HTTP 模式，省略则使用标准 I/O 模式

安装说明

在 Cursor 中安装

要在 Cursor 中安装和使用此 MCP 服务器：

在 Cursor 中，打开设置（⌘+,），导航到“MCP”标签。
点击“+ 添加新 MCP 服务器”。
输入以下信息：
- 名称：consul-assistant
- 类型：命令
- 命令：npx -y consul-mcp-server
点击“创建”。

在 Claude Desktop 中安装

要在 Claude Desktop 中安装和使用此 MCP 服务器：

下载并安装 Node.js 和 npm。
克隆仓库：

git clone https://github.com/3loka/consul-mcp-server.git
cd consul-mcp-server

安装依赖项：

npm install

启动 MCP 服务器：

npm start

📚 详细文档

项目结构

src/index.ts：主入口点
src/resources/：Consul API 交互代码
src/tools/：辅助功能，如图表生成
src/server/：MCP 服务器组件
src/mcp/：MCP 行为定义和处理程序
src/prompts/：AI 互动模板管理
src/tests/：测试套件

运行测试

npm test

构建项目

npm run build

🤝 贡献

欢迎贡献！请随意提交拉取请求。

📄 许可证

MIT

consul-mcp-server