使用说明
项目简介
kk_etcd MCP Server 是一个基于 Etcd 数据库构建的后端服务,它不仅提供配置中心和服务注册与发现功能,还实现了 MCP (Model Context Protocol) 服务器的功能。通过 MCP 协议,该服务器可以向 LLM(大型语言模型)客户端提供标准化的上下文信息和工具调用能力,使得 LLM 应用能够安全、可扩展地访问和管理 Etcd 中的数据和功能。
主要功能点
- 配置中心: 提供配置信息的存储、读取和管理功能,支持 YAML/JSON 格式的配置数据。
- 服务注册与发现: 支持 HTTP 和 gRPC 服务的注册和发现,方便构建微服务架构的应用。
- MCP Server: 实现了 MCP 协议,可以作为 LLM 应用的后端,提供资源 (Resources) 和工具 (Tools) 的访问接口。
- 用户和角色管理: 提供用户和角色管理功能,保障服务的安全性。
- 通过 MCP 工具调用 Etcd API: 将 Etcd 的常用操作(如 KV 读写、用户角色管理、备份恢复等)封装成 MCP 工具,方便 LLM 客户端调用。
安装步骤
-
下载仓库代码:
git clone https://github.com/cruvie/kk_etcd_go cd kk_etcd_go -
使用 Docker Compose 启动 (推荐):
确保您已安装 Docker 和 Docker Compose。在仓库的 'example' 目录下,使用 Docker Compose 启动 Etcd 和 kk_etcd MCP Server。
cd example docker-compose up -d这将启动 Etcd 数据库以及 kk_etcd MCP Server 服务。服务默认监听在 'http://localhost:2334' (客户端UI) 和 'http://localhost:2445/kk_etcd/sse' (MCP Server SSE endpoint)。
服务器配置 (MCP 客户端配置)
MCP 客户端需要配置以下信息以连接到 kk_etcd MCP Server。以下是一个 JSON 格式的配置示例,您需要根据您的 MCP 客户端进行相应的配置:
{ "serverName": "kk_etcd_mcp_server", "command": "docker", "args": [ "run", "-p", "2445:2445", "cruvie/kk_etcd_ui:latest-server" ], "transport": "sse", "baseUrl": "http://localhost:2445/kk_etcd/sse" }
配置参数说明:
- 'serverName': MCP 服务器的名称,可以自定义,用于在客户端标识不同的 MCP 服务器连接。例如: '"kk_etcd_mcp_server"'。
- 'command': 启动 MCP 服务器的命令。 使用 Docker 部署时,命令为 '"docker"'。
- 'args': 启动 MCP 服务器命令的参数列表。 使用 Docker 部署时,参数为 '["run", "-p", "2445:2445", "cruvie/kk_etcd_ui:latest-server"]',这会运行 'cruvie/kk_etcd_ui:latest-server' 镜像,并将容器的 2445 端口映射到主机的 2445 端口。请注意镜像版本 'latest-server' 可能需要替换为具体的版本号以确保兼容性。
- 'transport': MCP 客户端与服务器通信的传输协议,这里配置为 '"sse"' (Server-Sent Events)。
- 'baseUrl': MCP 服务器 SSE 接口的 base URL。 根据 Docker Compose 默认配置,这里设置为 '"http://localhost:2445/kk_etcd/sse"'。
注意: 请确保 MCP 客户端和服务器使用相同的版本,以避免版本不兼容导致的问题。 您可以在 Docker Hub 找到可用的镜像版本。
基本使用方法
- 启动 kk_etcd MCP Server (按照安装步骤使用 Docker Compose 启动)。
- 配置 MCP 客户端: 根据上述 “服务器配置” 示例,配置您的 MCP 客户端,使其连接到 'http://localhost:2445/kk_etcd/sse'。
- 在 MCP 客户端中调用工具 (Tools): kk_etcd MCP Server 将 Etcd 的管理功能暴露为一系列 MCP 工具 (Tools)。 您可以使用 MCP 客户端列出可用的工具,并调用这些工具来管理 Etcd 数据、用户、角色、进行备份恢复或执行 AI 查询等操作。 具体的工具列表和参数定义可以参考项目的 Swagger 文档 (如果已启用 Swagger,通常可以通过访问 'http://localhost:2333/swagger/index.html' 查看)。
例如,您可以使用 MCP 客户端调用 'KVList' 工具来列出 Etcd 中的 Key-Value 数据,或者调用 'UserAdd' 工具来添加新的用户。
信息
分类
开发者工具