Consul MCP Server 🚀

Consul MCP Server 🚀

site icon
2025.04.21 5
TypeScript服务管理健康检查键值存储会话管理事件处理预置查询状态监控代理管理系统健康开发效率数据库
Consul MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,通过标准化接口提供对 Consul 功能的访问。它主要用于服务管理、健康检查、键值存储、会话管理、事件处理、预置查询、状态监控和代理管理等功能。适用于需要集中管理和监控分布式服务的场景。
View on GitHub

Overview

基本能力

产品定位

Consul MCP Server 是一个中间件服务,通过 MCP 协议标准化 Consul 的功能访问,简化分布式系统的服务管理和监控。

核心功能

  1. 服务管理
  2. 列出运行中的服务
  3. 注册和注销服务
  4. 获取服务信息
  5. 列出目录服务
  6. 获取目录服务信息

  7. 健康检查

  8. 注册健康检查
  9. 注销健康检查
  10. 获取服务的健康检查

  11. 键值存储

  12. 从 KV 存储获取值
  13. 列出 KV 存储中的键
  14. 在 KV 存储中放入值
  15. 从 KV 存储中删除键

  16. 会话管理

  17. 列出会话
  18. 销毁会话

  19. 事件处理

  20. 触发事件
  21. 列出事件

  22. 预置查询

  23. 创建预置查询
  24. 执行预置查询

  25. 状态监控

  26. 获取当前领导者
  27. 获取当前对等节点

  28. 代理管理

  29. 获取代理成员
  30. 获取代理自身信息

  31. 系统健康

  32. 获取系统健康服务信息

适用场景

  • 分布式系统的服务发现和注册
  • 微服务架构的健康监控
  • 配置管理和键值存储
  • 分布式锁和会话管理
  • 事件驱动的系统通知

工具列表

  • MCP Inspector:用于调试和检查 MCP 服务器的运行状态。

常见问题解答

  1. 如何配置 Consul 服务器地址? 通过环境变量 CONSUL_HOSTCONSUL_PORT 配置。

  2. 如何启动服务器? 运行 node build/index.js

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 安装项目依赖:
npm install

安装教程

  1. 克隆项目仓库。
  2. 安装依赖:
npm install
  1. 构建项目:
npm run build
  1. 启动服务器:
node build/index.js

调试方式

  1. 构建项目并运行 Inspector:
npm run build && npx @modelcontextprotocol/inspector node build/index.js

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。