caddy-mcp

caddy-mcp

概述

caddy-mcp 是一个服务器，通过 Caddy API 提供用于管理 Caddy 实例的 Model Context Protocol（MCP）接口。它提供用于获取、更新和转换 Caddy 配置（支持 JSON、Caddyfile、YAML 或 Nginx 格式），以及监控反向代理上游的工具。该服务器支持通过不同传输方式运行：stdio、SSE 或 HTTP stream。

工具

• get_caddy_config - 以 JSON 格式获取当前的 Caddy 服务器配置
• update_caddy_config - 提供完整的 JSON 配置来更新 Caddy 服务器配置
• convert_caddyfile_to_json - 将 Caddyfile 配置转换为 JSON 格式
• convert_nginx_to_json - 将 Nginx 配置转换为 Caddy JSON 格式
• convert_yaml_to_json - 将 YAML 配置转换为 Caddy JSON 格式
• upstream_proxy_statuses - 以 JSON 格式获取已配置的反向代理上游的当前状态

构建步骤

1. 先决条件：

   • 安装 Go 1.24+（下载）

2. 克隆仓库：

   git clone https://github.com/lum8rjack/caddy-mcp.git
   cd caddy-mcp
   

3. 构建服务器：

   make
   # or
   go build -o caddy-mcp .
   

   这将在项目根目录中生成一个 caddy-mcp 二进制文件。

运行 MCP 服务器

你可以使用不同的传输方式和端口运行服务器：

./caddy-mcp -h
Usage of ./caddy-mcp:
  -port int
        Port to run the MCP server on (default 7000)
  -transport string
        The transport to use for the MCP server (stdio, sse, httpstream) (default "stdio")
  -url string
        The URL of the caddy server (default "http://127.0.0.1:2019")

MCP 设置示例：

{
    "mcpServers": {
        "caddy-mcp": {
            "command": "~/caddy-mcp",
            "args": ["-transport", "stdio", "-url", "http://127.0.0.1:2019"]
        }
    }
}

Caddyfile 示例

用于测试的示例 Caddyfile，其中公开了管理 API：

{
    admin :2019
}

:8080 {
    respond "I am 8080"
}

:8081 {
    respond "I am 8081"
}

添加其他 Caddy 模块

如果你使用的是带有额外模块的自定义 Caddy 构建版本（例如 Cloudflare DNS 模块），则需要将相应的 Go 模块添加到项目中。这样可确保 MCP 服务器能够与自定义 Caddy 构建版本配合使用。

步骤：

1. 将模块导入添加到 main.go：

   例如，要添加 Cloudflare DNS 模块，请添加以下导入（可放在导入列表中的任意位置，通常与其他 Caddy 模块放在一起）：

   import _ "github.com/caddy-dns/cloudflare"
   

2. 更新依赖项：

   运行：

   go mod tidy
   

3. 重新构建服务器：

   make
   # or
   go build -o caddy-mcp .
   

此过程可针对你需要的其他 Caddy 模块重复执行。如需查看官方和社区模块列表，请参阅 Caddy 模块目录。