Consul MCP Server

🚀 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 服務器：

1. 在 Cursor 中，打開設置（⌘+,），導航到“MCP”標籤。
2. 點擊“+ 添加新 MCP 服務器”。
3. 輸入以下信息：
   • 名稱：consul-assistant
   • 類型：命令
   • 命令：npx -y consul-mcp-server
4. 點擊“創建”。

在 Claude Desktop 中安裝

要在 Claude Desktop 中安裝和使用此 MCP 服務器：

1. 下載並安裝 Node.js 和 npm。
2. 克隆倉庫：

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

3. 安裝依賴項：

npm install

4. 啟動 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