article
README
🚀 Consul MCP 服务器
Consul MCP 服务器是一个借助标准化接口,为用户提供对 Consul 功能访问的 Model Context Protocol (MCP) 服务器,让用户能更便捷地操作 Consul 相关功能。
✨ 主要特性
该服务器提供对以下 Consul 功能的访问:
服务管理
- 列出运行中的服务
- 注册和取消注册服务
- 获取服务信息
- 列出目录中的服务
- 获取目录中服务的信息
健康检查
- 注册健康检查
- 取消注册健康检查
- 获取服务的健康检查状态
Key-Value 存储
- 从 KV 存储获取值
- 列出 KV 存储中的键
- 向 KV 存储写入值
- 从 KV 存储删除键
会话管理
- 列出会话
- 销毁会话
事件
- 发布事件
- 列出事件
预处理查询
- 创建预处理查询
- 执行预处理查询
状态信息
- 获取当前领导者
- 获取当前对等节点
代理信息
- 获取代理成员
- 获取代理自身信息
系统信息
- 获取系统健康服务信息
📦 安装指南
服务器可以通过环境变量进行配置:
CONSUL_HOST:Consul 服务器主机地址(默认:localhost)CONSUL_PORT:Consul 服务器端口(默认:8500)
💻 使用示例
基础用法
- 启动服务器:
node build/index.js
- 服务器将连接到 Consul 并通过 MCP 接口提供所有功能。
开发步骤
- 安装依赖项:
npm install
- 构建项目:
npm run build
- 运行检查工具:
npm run build && npx @modelcontextprotocol/inspector node build/index.js
Claude 配置
{
"mcpServers": {
"consul-mcp": {
"command": "node",
"args": [
"/ABSOLUTE/PATH/TO/PARENT/FOLDER/consul-mcp-server/build/index.js"
]
}
}
}
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group