Skip to main content
Glama

@yawlabs/caddy-mcp

npm version License: MIT GitHub stars

Claude Code, Cursor 및 모든 MCP 클라이언트에서 Caddy 웹 서버를 관리하세요. Caddy 관리 API의 모든 엔드포인트를涵盖하는 18개 도구 + 4개 리소스 — 구성, 라우트, 리버스 프록시, TLS, PKI, 메트릭, 스냅샷.

Yaw Labs에서 제작 및 유지 관리합니다.

Add to Yaw MCP

한 번의 클릭으로 이 항목을 로컬 Yaw MCP 구성에 추가하여 모든 Yaw Terminal 세션에서 사용할 수 있습니다. 또는 아래에서 수동으로 설치하세요.

왜 이건가요?

다른 Caddy MCP 서버는 관리 API의 절반만 감싸고 오류를 조용히 삼켜버립니다. 이 서버는 그렇지 않습니다.

  • 완전한 관리 API 커버리지 — 문서화된 모든 엔드포인트: /load, /config/*, /id/*, /stop, /adapt, /pki/ca/*, /reverse_proxy/upstreams, /metrics. 404를 반환하는 자리표시자 도구가 없습니다.

  • 안전한 동시 쓰기 — ETag(If-Match)를 사용하므로 변경 사항이 다른 사람의 변경 사항을 조용히 덮어쓰지 않습니다. HTTP 412 Precondition Failed를 난해한 오류가 아닌 명확한 메시지로 표시합니다.

  • 기본적으로 안전한 변경 — caddy_config_set은 append(POST)가 아닌 멱등적인 overwrite(PATCH)를 기본으로 사용합니다. 두 번 호출해도 라우트가 중복되지 않습니다.

  • 방어적 파싱 — caddy_list_routes는 라우트가 null이거나, 핸들러가 문자열이거나, 매처가 배열이 아닌 경우에도 잘못된 구성에서 절대 충돌하지 않습니다. 회귀 테스트를 거쳤습니다.

  • 오류에 자격 증명 노출 없음 — CADDY_ADMIN_URL의 경로/쿼리에 토큰이 포함된 경우 연결 실패 메시지에는 출처(origin)만 표시됩니다.

  • 폴백 오류 표시 — TLS 쓰기 PATCH가 실패하고 POST 폴백도 실패하면 두 오류 본문이 모두 반환되어 실제로 무엇이 잘못되었는지 알 수 있습니다.

  • 도구 주석 — 모든 도구가 readOnlyHint, destructiveHint, idempotentHint를 선언하므로 MCP 클라이언트는 안전한 작업에 대한 확인을 건너뛸 수 있습니다.

  • 즉시 시작 — 두 개의 런타임 의존성(MCP SDK + Zod)만 포함된 단일 번들로 제공됩니다. 5분짜리 node_modules 설치가 필요 없습니다.

  • 입력 강화 — 어댑터 이름, @id 값, 서버 이름, CA ID는 모두 길이 제한과 함께 정규식 검증을 거칩니다. CRLF 헤더 주입과 ReDoS를 차단합니다.

Related MCP server: cognigy-ai-mcp-management-server

빠른 시작

1. Caddy 관리 API 활성화

Caddy는 기본적으로 localhost:2019에서 관리 API가 활성화된 상태로 제공됩니다. Docker나 원격 호스트에서 Caddy를 실행 중이라면 CADDY_ADMIN_URL을 통해 노출하세요.

2. 프로젝트 루트에 .mcp.json 생성

macOS / Linux / WSL:

{
  "mcpServers": {
    "caddy": {
      "command": "npx",
      "args": ["-y", "@yawlabs/caddy-mcp@latest"]
    }
  }
}

Windows:

{
  "mcpServers": {
    "caddy": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@yawlabs/caddy-mcp@latest"]
    }
  }
}

Windows에서 추가 단계가 필요한 이유는? Node 20부터 child_process.spawn은 .cmd 파일을 직접 실행할 수 없습니다(Windows에서 npx가 바로 그런 파일입니다). cmd /c로 감싸는 것이 표준 해결 방법입니다. 이 파일은 비밀이 포함되어 있지 않으므로 커밋해도 안전합니다.

3. 다시 시작하고 승인

Claude Code(또는 MCP 클라이언트)를 다시 시작하고 프롬프트가 표시되면 Caddy MCP 서버를 승인하세요.

끝입니다. 이제 AI 어시스턴트에게 물어보세요:

"api.local을 localhost:3000으로 프록시해 줘"

"srv0에 어떤 라우트가 구성되어 있나요?"

"Prometheus 메트릭을 보여줘"

구성

환경 변수

기본값

설명

CADDY_ADMIN_URL

http://localhost:2019

Caddy 관리 API URL. Docker 내부에서는 http://caddy:2019로 설정하고, 원격 관리를 위해서는 https URL로 설정하세요. 또한 unix 소켓도 지원하며, unix:///var/run/caddy-admin.sock 또는 Caddy 고유의 unix//var/run/caddy-admin.sock 표기법을 모두 허용합니다 — 아래 참조.

CADDY_API_TOKEN

(없음)

인증이 필요한 관리 엔드포인트용 선택적 Bearer 토큰. Caddy에 인증을 구성한 경우에만 필요합니다.

CADDY_MCP_SNAPSHOT_DIR

(없음)

caddy_revert 스냅샷을 저장할 디렉터리. 설정하지 않으면 스냅샷은 메모리에만 존재하며 이 서버가 다시 시작되면 사라집니다. 스냅샷은 전체 Caddy 구성이며 비밀 정보를 포함할 수 있으므로 기본값이 아닌 선택적으로 지정합니다.

CADDY_MAX_RETRIES

2

일시적 오류(5xx, 네트워크 오류)에 대한 재시도 횟수. 4xx와 412는 절대 재시도하지 않습니다. /config/* 및 /id/*에 대한 POST도 재시도를 건너뜁니다(비멱등적 append/create — 재시도하면 라우트가 중복되거나 절반만 적용된 create가 409를 일으킬 수 있음). /load, /adapt, /stop에 대한 POST는 여전히 재시도합니다. 상한은 5로 고정되어 있으며, 상한을 초과하는 값은 일회성 stderr 알림을 기록하여 제한이 적용되었음을 확인할 수 있습니다. 0으로 설정하면 비활성화됩니다.

CADDY_TIMEOUT

10000

/load를 제외한 모든 관리 API 요청의 타임아웃(ms)입니다(/load는 CADDY_LOAD_TIMEOUT 사용). 숫자가 아니거나 <= 0이거나 1ms 미만의 분수 값이면 기본값으로 대체됩니다.

CADDY_LOAD_TIMEOUT

60000

/load 엔드포인트의 타임아웃(ms)입니다. 많은 인증서를 프로비저닝할 때 기본값을 초과할 수 있는 ACME 중심의 초기 구축에서는 값을 높이세요. 숫자가 아니거나 <= 0이거나 1ms 미만의 분수 값이면 기본값으로 대체됩니다.

Unix 소켓 관리 엔드포인트:

Caddy가 권장하는 보안 강화 방법은 관리 API를 루프백 포트에서 파일 시스템 권한으로 접근이 제어되는 unix 소켓으로 옮기는 것입니다:

{
  admin unix//var/run/caddy-admin.sock
}

CADDY_ADMIN_URL을 동일한 경로(unix:///var/run/caddy-admin.sock)로 지정하면 요청이 TCP 대신 소켓을 통해 전송됩니다. caddy-mcp를 실행하는 프로세스에는 소켓 파일에 대한 읽기/쓰기 권한이 필요합니다. 엔드포인트 앞에 인증이 있다면 CADDY_API_TOKEN도 여전히 적용됩니다.

기타 MCP 클라이언트:

클라이언트

구성 파일

Claude Code

.mcp.json (프로젝트 루트) 또는 ~/.claude.json (전역)

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json (macOS)

Cursor

~/.cursor/mcp.json

Windsurf

~/.codeium/windsurf/mcp_config.json

VS Code

.vscode/mcp.json

위에 표시된 것과 동일한 JSON 블록을 이 중 아무 곳에나 사용하세요.

도구

구성 관리 (6)

  • caddy_config_get — 모든 JSON 경로에서 구성 읽기(또는 전체 구성).

  • caddy_config_set — 경로에 구성 쓰기. 모드: overwrite(PATCH, 기본값, 멱등), append(POST), insert(PUT, 배열 위치용).

  • caddy_config_delete — 경로의 구성 삭제. confirm=true 필요(상위 경로를 삭제하면 모든 하위 항목도 제거됨).

  • caddy_config_by_id — @id 태그로 구성 가져오기/설정/삭제 — 깊은 경로를 탐색하는 것보다 훨씬 쉽습니다. delete 작업에는 confirm=true가 필요합니다.

  • caddy_load — 전체 구성을 원자적으로 교체. 인증서 프로비저닝을 위한 60초 타임아웃. 이전 구성을 자동으로 스냅샷합니다.

  • caddy_revert — 롤백을 위한 구성 스냅샷 관리. 작업: list, save, apply(확인 필요). 메모리 내 저장, 최근 10개.

라우트 작업 (4)

  • caddy_reverse_proxy — 한 번의 호출로 리버스 프록시 추가: from='api.local' to=['localhost:3000']. 멱등 쓰기를 위해 선택적 id를 전달하세요 — 반복 호출 시 라우트를 중복하지 않고 제자리에서 교체합니다.

  • caddy_add_route — 전체 match/handle 제어로 라우트 추가(모든 Caddy 핸들러).

  • caddy_remove_route — @id(권장) 또는 인덱스로 라우트 제거. confirm=true 필요.

  • caddy_list_routes — 사람이 읽을 수 있는 라우트 요약. 방어적: 이상한 구성에서도 절대 충돌하지 않습니다.

TLS 및 구성 변환 (2)

  • caddy_tls — TLS 설정 확인 또는 설정: ACME 이메일, ACME CA URL. 먼저 PATCH를 시도하고, 새 설치에서는 최소 구성을 POST합니다. 기존 구성이 있으면 issuer 경로에 깊게 병합한 후 결과를 PUT으로 다시 작성하여 형제 항목(사용자 지정 인증서, on_demand, 추가 정책)을 보존합니다. 기존 구조가 예상과 다르면 형태별 오류와 함께 거부합니다 — 절대 덮어쓰지 않습니다.

  • caddy_adapt — 등록된 어댑터 형식의 구성을 적용하지 않고 Caddy JSON으로 변환. caddyfile(내장, 기본값) 및 Caddy 바이너리에 컴파일된 모든 어댑터 모듈 — 예: nginx(caddy-nginx-adapter), yaml(caddy-yaml). 기존 구성을 미리 보거나 이식할 때 유용합니다.

서버 작업 (6)

  • caddy_status — 연결 확인 + 구성 요약(서버 수, 라우트, TLS 모드).

  • caddy_list_servers — 이름, 주소, 라우트 수, TLS 상태를 포함한 모든 HTTP 서버 나열.

  • caddy_upstreams — 리버스 프록시 백엔드 상태.

  • caddy_metrics — Prometheus 메트릭(요청 수, 지속 시간, 연결, TLS 핸드셰이크). 선택적 filter(메트릭 이름의 부분 문자열 일치, 유지된 메트릭의 # HELP / # TYPE 줄 보존)와 max_lines(기본값 500)로 바쁜 서버에서 응답을 간결하게 유지합니다.

  • caddy_pki — CA 정보 및 인증서 체인(기본 CA: local).

  • caddy_stop — 정상 종료. 사고를 방지하려면 confirm=true가 필요합니다.

리소스

탐색 가능한 읽기 전용 데이터 — MCP 클라이언트는 도구 호출 없이 직접 가져올 수 있습니다:

  • caddy://config — 현재 전체 Caddy JSON 구성.

  • caddy://servers — 구성된 모든 HTTP 서버 요약.

  • caddy://upstreams — 리버스 프록시 업스트림 상태.

  • caddy://metrics — Prometheus 메트릭(텍스트 exposition 형식). 클라이언트 컨텍스트를 제한하기 위해 처음 500줄로 제한됩니다. 필터링되거나 더 큰 출력이 필요하면 filter / max_lines와 함께 caddy_metrics 도구를 사용하세요.

예제

리버스 프록시 추가

> "Proxy api.example.com to my app on port 3000"
→ caddy_reverse_proxy({ from: "api.example.com", to: ["localhost:3000"] })

멱등 리버스 프록시 (자동화에서 다시 실행해도 안전)

> "Make sure api.example.com points at localhost:3000, with a stable id"
→ caddy_reverse_proxy({ from: "api.example.com", to: ["localhost:3000"], id: "api-prod" })
  # First call creates the route under @id="api-prod".
  # Subsequent calls with the same id REPLACE in place — no duplicate routes.
  # Refuses with a clear error if "api-prod" is already in use by a non-route
  # config object (TLS issuer, server, etc.) — @ids are config-global in Caddy.

Prometheus 메트릭 필터링

> "Just the HTTP request metrics, please"
→ caddy_metrics({ filter: "http_requests" })
  # Keeps sample lines whose metric name contains "http_requests",
  # plus their `# HELP` / `# TYPE` lines. Drops the rest.

적용 전에 Caddyfile 미리 보기

> "Convert this Caddyfile to JSON so I can review it:
   example.com {
     reverse_proxy localhost:8080
   }"
→ caddy_adapt({ config: "..." })

느린 라우트 진단

> "Fetch Prometheus metrics and tell me which route is slowest"
→ caddy_metrics()

@id로 경로를 안전하게 업데이트

> "Update the route with @id 'api-v2' to point to the new backend"
→ caddy_config_by_id({ id: "api-v2", action: "set", value: {...} })
  # Uses ETags — you'll get HTTP 412 if someone else changed it first

원자적 배포

> "Replace the whole config with this Caddyfile"
→ caddy_adapt({ config: "..." })  # validate first
→ caddy_load({ config: adaptedJson })  # apply atomically

문제 해결

"Caddy admin API에 연결할 수 없음"

  • Caddy가 실행 중인지 확인하세요. caddy run 또는 systemctl status caddy.

  • admin 엔드포인트를 확인하세요. 기본값은 http://localhost:2019입니다. Caddy가 Docker에 있으면 컨테이너 호스트 이름을 사용하세요.

  • 일치하도록 MCP config env에서 CADDY_ADMIN_URL을 설정하세요.

"HTTP 412 Precondition Failed"

  • 읽기와 쓰기 사이에 누군가(또는 무언가)가 구성을 변경했습니다.

  • 캐시된 ETag가 무효화되었습니다. 구성을 다시 읽고 재시도하세요.

/load 또는 /config 쓰기 시 "HTTP 403"

  • Caddy config에 admin.listen 또는 admin.origins 제한이 설정되어 있거나 Authorization 헤더가 누락되었습니다.

  • Caddy가 Bearer 토큰을 기대하는 경우 MCP config env에 CADDY_API_TOKEN을 설정하세요.

SIGUSR1 / systemctl reload caddy가 Caddyfile을 다시 로드하지 않음

  • 예상된 동작이며 여기서 버그로 인한 것이 아닙니다. Caddy 2.11.1부터 SIGUSR1은 admin API를 통해 구성이 한 번도 변경된 적이 없는 경우에만 디스크의 파일에서 다시 로드합니다. caddy-mcp(또는 다른 API 클라이언트)의 첫 번째 쓰기로 Caddy는 실행 중인 구성을 API 소유로 간주하며 SIGUSR1은 no-op이 됩니다.

  • 인스턴스당 소유자를 하나 선택하세요. Caddyfile이 진실의 원천이면 caddy-mcp 읽기 전용 도구(caddy_status, caddy_list_routes, caddy_adapt)를 사용하고 파일에서 다시 로드하세요. caddy-mcp가 구성을 소유하면 SIGUSR1 대신 caddy_load로 변경 사항을 적용하세요.

Windows: MCP 서버가 시작되지 않음

  • 빠른 시작 섹션의 cmd /c npx ... 패턴을 사용하세요. Node 20+는 .cmd 파일을 직접 생성(spawn)할 수 없습니다.

요구 사항

  • Node.js 20+

  • admin API가 활성화된 Caddy 2.x(기본값: localhost:2019). Caddy 2.11.4로 검증되었습니다. @id 쓰기 경로는 라이브 통합 스위트가 릴리스마다 고정하는 PATCH 의미 체계에 의존합니다.

기여

git clone https://github.com/YawLabs/caddy-mcp.git
cd caddy-mcp
npm install
npm run lint       # Biome check
npm run lint:fix   # Auto-fix
npm run build      # tsup bundle
npm test           # Vitest (357 unit tests, +9 POSIX-only unix-socket tests; +13 live-Caddy integration tests gated by CADDY_MCP_INTEGRATION=1)
npm run typecheck  # tsc --noEmit

전체 워크플로와 릴리스 프로세스는 CONTRIBUTING.md를 참조하세요.

라이선스

MIT

Available Tools

18 tools
caddy_adaptA
Read-onlyIdempotent

Convert a config in any registered adapter format to Caddy JSON without loading it. Useful for previewing what a Caddyfile produces, or for porting from nginx/yaml configs when Caddy is built with the matching adapter module ('caddyfile' is built-in; 'nginx', 'yaml', etc. require their adapter modules to be compiled into the Caddy binary). Returns the adapted JSON and any warnings separately. One exception to 'without loading it': on Caddy <= 2.11.4 a Caddyfile 'order' global option is not preview-only. It mutates that Caddy process's directive order, so it carries into every later Caddyfile adapt or load there, and an 'order' line that FAILS (unknown target, bad positional, extra arg) still removes the directive it names -- later Caddyfiles using that directive then fail with "directive 'X' is not an ordered HTTP handler" until another 'order' line re-places it or Caddy restarts. Fixed upstream in caddyserver/caddy#7995, unreleased as of v2.11.4.

NameRequiredDescriptionDefault
configYesThe raw config text (e.g., Caddyfile contents, nginx.conf, yaml)
adapterNoConfig format adapter. Must match an adapter Caddy was built with. Built-in: 'caddyfile' (default). Common external adapters: 'nginx' (caddy-nginx-adapter), 'yaml' (caddy-yaml).caddyfile

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, but the description adds a crucial behavioral caveat: on Caddy <= 2.11.4, the 'order' global option mutates the process's directive order despite the preview-only claim. This goes beyond annotations and is essential for correct usage. It also explains the return format (adapted JSON and warnings).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long, but every part earns its place: the core purpose, the usage context, and the version-specific caveat. It is front-loaded with the primary action, and the detailed exception is justified because it materially affects behavior. Slightly dense but not verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with a subtle mutation risk, the description covers the version-specific behavior, the return value (adapted JSON plus warnings), and adapter requirements. There is no output schema, so the description correctly explains what the agent will receive. Nothing essential is missing for safe invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with descriptions for both config and adapter, so the baseline is 3. The description adds context about adapter module availability (built-in vs. compiled external modules), which complements the schema and helps the agent choose the right adapter. Not a large addition but useful.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear verb+resource: 'Convert a config in any registered adapter format to Caddy JSON without loading it.' It distinguishes itself from siblings like caddy_load by explicitly stating 'without loading it', so an agent can tell it apart immediately.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states when to use the tool ('previewing what a Caddyfile produces, or for porting from nginx/yaml configs') and specifies the adapter module prerequisite. It also warns about the 'order' mutation on older versions, effectively covering a when-not-to-trust-preview-only scenario.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_add_routeA

Add a route with full control over match conditions and handlers. Supports any Caddy handler (reverse_proxy, file_server, static_response, redirect, encode, headers, etc.).

NameRequiredDescriptionDefault
matchYesArray of match objects (e.g., [{ host: ['example.com'], path: ['/api/*'] }])
handleYesArray of handler objects (e.g., [{ handler: 'file_server', root: '/var/www' }])
serverNoCaddy server name (default: srv0)srv0
terminalNoStop processing further routes after this one matches

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations are all false, providing minimal safety context (not read-only, not idempotent, not destructive). The description adds capability details (supports any handler) but does not disclose behavioral traits such as whether the route is appended or overwrites existing routes, validation behavior, or reversibility. This is a moderate gap for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the action, and contains no fluff. Every word adds relevant context about what the tool does and its flexibility.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the 100% schema coverage and absence of an output schema, the description covers the tool's purpose and scope effectively. It misses some behavioral context (e.g., route ordering, interaction with terminal flag) but is reasonably complete for a config-modifying tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by enumerating common handler types (reverse_proxy, file_server, etc.) and emphasizing 'full control', which helps the agent understand the flexible, free-form nature of the match and handle parameters beyond the schema's minimal examples.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's action ('Add a route') and its scope ('full control over match conditions and handlers'). It also lists specific handler types, which distinguishes it from sibling tools like caddy_remove_route and caddy_list_routes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'full control' implies this is the general-purpose tool for adding routes, and mentioning 'any Caddy handler' suggests flexibility. However, it does not explicitly state when to use this versus alternatives like caddy_reverse_proxy, nor does it provide any exclusions or when-not-to-use guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_config_by_idA
Destructive

Access config by @id tag. Any config object with an '@id' field can be read, updated, or deleted by its ID instead of needing its full path. This is the recommended way to manage individual routes and config objects. The 'delete' action requires confirm=true. Every 'set' and 'delete' first asks Caddy where id resolves, and refuses an id that does not resolve inside the config tree (including an unknown one). If Caddy resolves id to the config ROOT -- normally because it is the config's own top-level '@id', string or number -- it names the ENTIRE config: 'set' and 'delete' with no subpath (or a lone '...') then act on the whole configuration exactly as caddy_config_set and caddy_config_delete do at the config root -- 'set' replaces it and 'delete' unloads it, the 'admin' block included, so Caddy's admin endpoint can move and CADDY_ADMIN_URL stop reaching it. Both then require confirm=true, snapshot the prior config first so caddy_revert can restore it, and report where the admin endpoint went. A subpath inside it (e.g. 'apps/http') is an ordinary write.

NameRequiredDescriptionDefault
idYesThe @id value of the config object
modeNoFor 'set' action: 'overwrite' = PATCH (replace the identified object, or the value at subpath; default). 'append' = POST and 'insert' = PUT behave as in caddy_config_set at the resolved path: with a subpath into an array, POST appends and PUT inserts at the index; PUT also strictly creates an object key (409 if it exists). With NO subpath: for an array element (a route) neither replaces it — POST adds the value as a new element at the end of that array, PUT inserts it just before the identified one, and both are rejected with 'duplicate ID' if the value carries the same @id; for an object held under a key (a server) POST REPLACES it wholesale and PUT fails with 409. Use 'overwrite' to replace in place.overwrite
valueNoNew value (required for 'set' action)
actionNoAction to performget
confirmNoMust be true to actually delete, and to 'set' when Caddy resolves `id` to the config root (that replaces the ENTIRE config). Ignored for every other 'set'.
subpathNoOptional sub-path within the identified object

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description discloses extensive behavioral details beyond annotations: delete requires confirm=true, set/delete validate the id resolves, root-id handling replaces/unloads the entire config, snapshots for revert, and admin endpoint reporting. This exceeds the destructiveHint annotation and provides critical safety context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but every sentence adds value, covering core purpose, edge cases, and safety constraints. It is front-loaded with the primary function and systematically explains special behaviors. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema, the description explains key success/failure behaviors (refusal of unknown ids, root handling, admin endpoint relocation). All 6 parameters are documented in the schema, and the description covers the main edge cases, making it fully sufficient for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and parameter descriptions are already detailed, especially for 'mode' and 'confirm'. The description adds behavioral context (e.g., id resolution) but does not substantially extend parameter meaning beyond the schema, so the baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('read, updated, or deleted') and resource ('config object by @id tag'), and explicitly distinguishes it from path-based access. It also identifies it as the recommended way to manage individual routes, differentiating it from sibling tools like caddy_config_set/get.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly indicates when to use this tool (for individual config objects with @id) and explains the root-id special case where it behaves like caddy_config_set/delete. It does not explicitly name alternatives for non-root operations, but the context implies it's the go-to for individual objects, which is sufficient guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_config_deleteA
Destructive

Delete config at a JSON path. Removes the config node at the specified path. Deleting a parent node also deletes every descendant -- e.g. deleting 'apps/http/servers/srv0' removes that server and all of its routes. Requires confirm=true. Any path that addresses the config ROOT ('', '/', 'config', '/config/', slash-only variants of those, or any of those followed by a lone '...' segment) addresses the ENTIRE config and unloads it: every app and server goes, and so does the 'admin' block, after which Caddy re-binds its admin endpoint to its default address (localhost:2019, or $CADDY_ADMIN in Caddy's environment). If CADDY_ADMIN_URL points anywhere else, neither this server nor caddy_revert can reach Caddy afterwards. A root delete is snapshotted first, so caddy_revert can restore it while Caddy is still reachable; no other path is snapshotted. To REPLACE the config rather than unload it, use caddy_load.

NameRequiredDescriptionDefault
pathYesConfig path to delete (e.g., 'apps/http/servers/srv0/routes/0')
confirmNoMust be true to actually delete the config node (safety)

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the destructiveHint annotation, the description discloses important behaviors: deleting a parent deletes descendants, root deletes unload the entire config, only root deletes are snapshotted for caddy_revert, and the admin endpoint may rebind or become unreachable. This is substantial context that prevents catastrophic misuse.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but every sentence earns its place by clarifying dangerous edge cases, alternatives, and recovery behavior. The core action is front-loaded, with the risky root-path details following naturally. No fluff or repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, high-stakes tool, the description covers outcomes, side effects, snapshot behavior, admin endpoint implications, and the alternative replacement tool. The absence of an output schema is acceptable because the behavioral consequences are fully disclosed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds meaningful semantics for the path parameter, especially the root-path variants and their full-unload behavior, and reinforces the confirm=true requirement. This goes beyond simply restating the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's action: deleting config at a JSON path and removing the config node. It distinguishes itself from caddy_load by explicitly noting that replacing the config is a different operation. The verb+resource combination is specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit guidance around the root-path danger and names caddy_load as the alternative when replacement is intended. It also states that confirm=true is required. It does not enumerate every sibling alternative, but the critical routing decision is covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_config_getA
Read-onlyIdempotent

Read Caddy config at any JSON path. Returns the full config when path is empty, or a subtree at a specific path (e.g., 'apps/http/servers/srv0/routes').

NameRequiredDescriptionDefault
pathNoConfig path (e.g., 'apps/http/servers/srv0')

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is covered. The description adds valuable behavioral context by explaining the return behavior for empty vs. specific paths, which goes beyond the structured annotations and helps the agent predict the tool's output.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the core action, and every word adds value. It avoids needless detail while including a practical example. No redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only tool with one optional parameter and no output schema, the description covers the essential behaviors: full config vs. subtree, path example, and empty path default. It doesn't mention error handling or exact output format, but these are relatively minor gaps given the tool's simplicity and strong annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% for the only parameter 'path', but the description enriches its meaning by explicitly stating that an empty path returns the full config and providing a concrete example ('apps/http/servers/srv0/routes'). This goes beyond the schema's generic 'Config path' description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool reads Caddy config at a JSON path, with a specific verb ('Read') and resource. It distinguishes itself from siblings by being the generic config getter, while other tools handle writes, deletes, or specific lookups. The clarification of empty path returning the full config adds scope precision.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The intended usage is implied: use this to read config by path. However, there is no explicit guidance on when to prefer this tool over alternatives like caddy_config_by_id or caddy_status, nor any exclusions. The description provides clear context but no comparative direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_config_setA
Destructive

Write config at a JSON path. Mode 'overwrite' (default) replaces the value at the path (PATCH) — idempotent, but it replaces the WHOLE subtree there: writing [] to '.../routes' drops every route. Mode 'append' (POST) adds to an array — NOT idempotent: calling twice with the same route duplicates it — but on a non-array key it REPLACES whatever is there, and it cannot create missing parent objects. Mode 'insert' (PUT) inserts at an array index (useful for route ordering), or strictly creates an object key together with any missing parents and fails with 409 if the key already exists — the safe way to create a server or app, including on an instance with no config at all. Any path that addresses the config ROOT ('', '/', 'config', '/config/', a slash-only variant, or any of those followed by a lone '...' segment) addresses the ENTIRE config and requires confirm=true: 'overwrite' and 'append' there REPLACE the whole configuration with value — Caddy runs it exactly as caddy_load would — so every app, server and route not in value is discarded, and so is the 'admin' block unless value carries one. Caddy then re-binds its admin endpoint to the new config's admin.listen, or to its default address (localhost:2019, or $CADDY_ADMIN in Caddy's environment) when it sets none, or to no address at all when it sets admin.disabled; if CADDY_ADMIN_URL points anywhere else, neither this server nor caddy_revert can reach Caddy afterwards. A root write is snapshotted first, so caddy_revert can restore it while Caddy is still reachable; no other path is snapshotted. 'insert' at the root only succeeds after a root caddy_config_delete (Caddy answers 409 on any other instance, including one started with no config), and 'overwrite' is the reverse: after a root caddy_config_delete it answers 404 until 'append', 'insert' or caddy_load re-creates the config. To replace the whole config deliberately, caddy_load does the same thing behind the same gate and also accepts a Caddyfile.

NameRequiredDescriptionDefault
modeNo'overwrite' = PATCH (replace existing, default, idempotent; 404 if the key does not exist), 'append' = POST (appends to arrays, NOT idempotent; REPLACES an existing non-array key; cannot create missing parents), 'insert' = PUT (inserts at an array index, or strictly creates an object key and any missing parents; 409 if the key exists)overwrite
pathYesConfig path to write to (e.g., 'apps/http/servers/srv0/routes')
valueYesThe JSON value to set at the path
confirmNoMust be true when `path` addresses the config root ('', '/', 'config', '/config/', slash-only variants, or a lone '...' segment): that write replaces the ENTIRE config (safety). Ignored for every other path.

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the destructiveHint annotation, the description discloses major non-obvious consequences: root writes discard all apps, servers and routes not in `value`, may re-bind the admin endpoint and can make Caddy unreachable from both this server and caddy_revert; append is non-idempotent; insert at root only works after a root caddy_config_delete; and root writes are snapshotted while other paths are not. This is exactly the kind of behavioral context an agent needs.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long, but every sentence carries unique operational or safety information, covering mode behavior, root-path edge cases, error codes, admin endpoint reachability, and interaction with caddy_load/caddy_revert. The core purpose is front-loaded in the first sentence, and the rest is logically grouped, making it a dense but efficient reference.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no output schema and only a destructive annotation, the description covers error conditions (404, 409), preconditions (root delete before insert), side effects on admin endpoint connectivity, rollback capability, and interactions with sibling tools. An agent can correctly invoke this tool and anticipate all major consequences across every required mode.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds critical meaning beyond the schema's one-line mode definitions: it explains that writing [] to routes drops every route, that append replaces non-array keys and cannot create parents, that insert fails with 409 if the key exists, and the precise root path variants and confirm=true requirement. It enriches the semantics of path, mode, and confirm substantially.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence states a specific action and resource ('Write config at a JSON path'), and the description immediately distinguishes the three modes (overwrite/append/insert) with their HTTP semantics. It also differentiates from caddy_load by noting that tool replaces the whole config while this one targets a path (except at root), and contrasts with caddy_revert and caddy_config_delete in the behavioral descriptions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides explicit guidance for when to use each mode: 'insert' is called the safe way to create a server or app, 'append' is for arrays, and 'overwrite' for replacement. It explicitly directs whole-config replacements to caddy_load as the deliberate alternative and mentions caddy_revert for rollback after root writes, giving agents clear decision criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_list_routesA
Read-onlyIdempotent

List all routes on a Caddy HTTP server with a human-readable summary of matchers and handlers, followed by the raw route JSON. Both halves are capped on large servers: the summary at 500 routes, the JSON at 20000 characters (truncated on whole-route boundaries, so it always parses). When either cap trims output, a note says how many routes were omitted -- read the rest with caddy_config_get at 'apps/http/servers//routes'.

NameRequiredDescriptionDefault
serverNoCaddy server name (default: srv0)srv0

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/non-destructive, and the description adds significant behavioral detail: output caps (500 routes/20000 chars), whole-route truncation, omission note, and exact fallback path. This fully discloses edge-case behavior without contradicting annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three dense sentences that each add distinct value: purpose/output, caps/truncation, and fallback. No redundant filler; structure is well-organized.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only list operation with one optional parameter and no output schema, the description covers output format, limits, edge-case behavior, and how to get the complete data. It is fully self-contained for an agent to invoke and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The only parameter 'server' is already documented in the schema with default 'srv0' and 100% coverage. The description does not add additional parameter-level detail but doesn't need to given the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it lists all routes on a Caddy HTTP server and describes the dual output (summary + raw JSON). The use of 'all routes' and explicit reference to caddy_config_get for reading the rest distinguishes it from sibling config-read tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies use when you want a quick route overview on a specific server, and explicitly directs to caddy_config_get at a specific JSON path for the full untruncated data. The cap behavior and omission note also tell the agent when the result is incomplete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_list_serversA
Read-onlyIdempotent

List all configured HTTP servers with their names, listen addresses, route counts, and TLS status. Use this to discover server names before calling route tools.

NameRequiredDescriptionDefault

No parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare this as a safe, read-only, idempotent operation. The description adds transparency about the output content (specific server attributes), which is helpful given there is no output schema. This goes beyond what annotations alone provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences, front-loaded with the action and output details, followed by a practical usage hint. Every sentence contributes value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter, read-only list operation with strong annotations, this description is complete. It tells the agent exactly what the tool does, what it returns, and when to invoke it, making tool selection and usage straightforward.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so the schema is fully covered by default. Per the baseline for 0-parameter tools, the description appropriately focuses on behavior and output rather than parameter explanations.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the operation as listing all configured HTTP servers and specifies the exact data returned (names, listen addresses, route counts, TLS status). This distinguishes it from sibling tools like caddy_list_routes, which focus on routes rather than servers.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use the tool: 'Use this to discover server names before calling route tools.' This provides a clear workflow context, though it does not explicitly name alternatives or exclusion cases.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_loadA
DestructiveIdempotent

Replace the entire Caddy configuration atomically. Accepts a JSON config object, or a Caddyfile string with format='caddyfile'. This is the safest way to make large config changes. Runs on CADDY_LOAD_TIMEOUT (55 s by default), like every config change; a load that times out is not retried and may still apply, so re-read the config before loading again. Requires confirm=true: this DISCARDS the entire running config, including servers and routes not present in the supplied config. The prior config is snapshotted first and can be restored with caddy_revert.

NameRequiredDescriptionDefault
configYesFull config — JSON object or Caddyfile text string
formatNoConfig format: 'json' (default) or 'caddyfile'json
confirmNoMust be true to replace the running configuration (safety)

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Despite strong annotations (destructiveHint=true, idempotentHint=true), the description adds substantial extra context: atomic replacement, disposal of the entire running config, snapshot and revert via caddy_revert, and the non-retry/may-still-apply behavior on timeout. It explicitly states confirm=true is required and clarifies the destructive impact. This goes far beyond the annotations and is directly actionable.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences, progressively delivering the core action, safety/timeout details, and the confirm requirement. It is front-loaded with the primary purpose and contains no filler. Every clause contributes critical information, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, full-config replacement tool, the description covers the essential elements: action, accepted formats, timeout behavior, confirm requirement, and revert path. It omits explicit output/return information, but there is no output schema, and the caution to re-read config implies the operation's effects may not be immediately visible. This is sufficient for an agent to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with descriptions for all three parameters. The description mostly mirrors the schema for config and format, and for confirm it reiterates the safety requirement without adding new parameter-level meaning. The added value lies in behavioral context (timeout, discard) rather than parameter semantics, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description begins with a specific action: 'Replace the entire Caddy configuration atomically.' It clearly identifies the resource (entire Caddy configuration) and the verb (replace). The mention of atomicity and acceptance of JSON or Caddyfile distinguishes it from sibling tools like caddy_config_set (incremental changes) and caddy_add_route (route-specific).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description states it is 'the safest way to make large config changes,' giving clear context for when to use it. However, it does not explicitly mention alternatives or exclusion criteria (e.g., 'for incremental changes, use caddy_config_set'). It does provide related caution about timeout and re-reading config, which supports proper usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_metricsA
Read-onlyIdempotent

Get Prometheus metrics from Caddy. Shows request counts, durations, TLS handshake stats, active connections, and more. Output can be megabytes on busy servers -- use filter to keep only metrics whose name contains a substring (e.g. 'http_requests' or 'tls'); HELP/TYPE comment lines for retained metrics are kept. Filter-mode drops blank lines and free-form '# comment' lines, keeping only '# HELP'/'# TYPE' lines for matching metrics; the '# EOF' end-of-file marker is always preserved. Use max_lines to cap the response (default 500); a trailing comment reports how many lines were dropped.

NameRequiredDescriptionDefault
filterNoSubstring to match against metric names. Keeps sample lines whose metric name contains this substring, plus their `# HELP` and `# TYPE` comment lines. Empty/absent = no filtering. Label values are NOT matched -- use a Prometheus-aware client for label filtering.
max_linesNoMaximum number of output lines (default 500). Excess lines are dropped and a summary is appended.

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds substantial behavioral context: output can be megabytes, filter-mode drops blank/free-form comments but preserves HELP/TYPE lines, '# EOF' is always kept, max_lines defaults to 500, and a trailing comment reports dropped lines. This goes well beyond the structured hints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized—four sentences that lead with the core purpose, then dive into parameter behavior with examples. Every sentence carries unique, essential information; there is no repetition or filler. The structure flows logically from purpose to usage to edge cases.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with no output schema, the description covers the return format implicitly (Prometheus text) and explicitly covers filtering semantics, line handling, size limits, and the trailing summary. It gives the agent enough context to anticipate output characteristics and pitfalls, making it complete for invocation and result handling.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema coverage is 100%, the description significantly enriches parameter meaning. It explains that filter is a substring match on metric names, that HELP/TYPE lines for matching metrics are retained, and that label values are NOT matched. For max_lines, it details the default (500) and the appended summary line, which the schema does not fully convey.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb+resource: 'Get Prometheus metrics from Caddy.' It lists concrete metric categories (request counts, durations, TLS handshake stats, active connections) and clearly distinguishes this tool from sibling tools like caddy_config_get or caddy_status, which serve different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear guidance on when to use the filter and max_lines parameters, including examples and edge-case behavior (label values not matched). It does not explicitly contrast with alternatives, but among the siblings none offer metrics, so the context is clear enough for tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_pkiA
Read-onlyIdempotent

Get PKI certificate authority info or the CA certificate chain.

NameRequiredDescriptionDefault
caNoCA ID (default: 'local')local
certificatesNoIf true, return the full CA certificate chain

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds little beyond repeating the certificates parameter's effect, and does not disclose additional behavioral traits such as output format or error behavior. No contradiction with annotations exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, focused sentence that begins with the verb and directly states the tool's purpose. No filler or redundant information, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is a simple read-only getter with no output schema, yet the description is vague about what 'info' includes or what the response format looks like. While annotations and schema cover parameters and safety, the description lacks contextual detail about the return value or edge cases, making it minimally adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema coverage is 100% (both 'ca' and 'certificates' have descriptions). The description does not add any additional meaning beyond the schema, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description starts with the verb 'Get' and clearly identifies the resource as 'PKI certificate authority info or the CA certificate chain.' This is specific and distinguishes it from siblings like caddy_config_get or caddy_status, which have different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies its usage as a read-only query for PKI CA information, but does not explicitly state when to use it over alternatives like caddy_tls or caddy_config_get. No exclusions or alternative tool references are provided, so guidance is only implicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_remove_routeA
Destructive

Remove a route. Target by @id (preferred — stable across reorderings) or by array index on a specific server. Index-based removal is a two-step read-then-delete and can race against concurrent edits; prefer @id when possible. Only the @id mode is idempotent: a repeat call cannot remove a different route, it just reports the id as gone. The index mode is NOT — Caddy re-packs the routes array after a removal, so calling with index 2 twice removes TWO DIFFERENT routes. @ids are config-global in Caddy (NOT route-scoped): if id resolves to a non-route object (TLS issuer, server, etc.) the call refuses rather than deleting it.

NameRequiredDescriptionDefault
idNoThe @id of the route to remove (preferred — stable even if routes get reordered)
indexNoZero-based index of the route in the server's routes array (only used if id is not provided)
serverNoCaddy server name when using index (default: srv0). Ignored when id is provided.srv0
confirmNoMust be true to actually remove the route (safety)

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description goes well beyond the annotations by clarifying that idempotency is mode-dependent: @id mode is idempotent, while index mode is not and can remove different routes on repeated calls. It also discloses the two-step read-then-delete race, the config-global scope of @ids, and the refusal behavior when the id resolves to a non-route object. This is excellent behavioral disclosure for a destructive tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Every sentence carries essential operational or safety information. The description is front-loaded with the core action, then systematically covers target selection, idempotency differences, concurrency hazards, and scope semantics. There is no filler or repetition that does not earn its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, non-idempotent tool with no output schema, the description is remarkably complete. It addresses the main failure modes (race conditions, repeated index removal, non-route @id targets), explains the confirm-based safety mechanism indirectly through the schema, and gives the agent enough context to call the tool correctly and avoid destructive mistakes.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds meaningful context beyond the schema: it explains why id is preferred, warns that index removal re-packs the routes array, and clarifies that @ids are config-global rather than route-scoped. This enriches the agent's understanding of how id and index actually behave.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a direct, specific statement—'Remove a route'—and immediately identifies the two targeting modes (@id or index on a specific server). This clearly distinguishes it from generic config deletion tools and from route-modification siblings like caddy_add_route or caddy_list_routes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives explicit usage guidance: prefer @id because it is stable across reorderings, avoid index mode when possible because it can race against concurrent edits. It does not explicitly compare this tool to alternatives like caddy_config_delete, but the contextual guidance for choosing between the tool's own modes is strong and concrete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_reverse_proxyA
Destructive

Add a reverse proxy route. The most common operation — just specify where traffic comes from and where it goes. Example: from='api.local' to=['localhost:3000']. When id is OMITTED the route is appended to the server's routes array — calling the tool twice with the same args produces TWO duplicate routes (non-idempotent). When id is SUPPLIED the route is written via PATCH under that @id, so repeat calls REPLACE in place (idempotent). Strongly recommended: supply a stable id for any route managed from automation or production tooling. Note: @ids are config-global in Caddy (NOT route-scoped). If id collides with an @id used by a non-route object (TLS issuer, server, etc.) the call refuses with an error rather than clobbering it. Once an @id is registered to a route under one server, subsequent calls update that route in place regardless of the server argument. Upstream scheme is honored: an https:// upstream gets a TLS transport and defaults to port 443, anything else is dialed in the clear. A to list that MIXES https:// and non-https entries is refused — the TLS transport applies to the whole handler, not per-upstream — so split those into two routes or use caddy_add_route.

NameRequiredDescriptionDefault
idNoOptional stable @id for the route. When set, repeat calls REPLACE the route in place (idempotent). When omitted, the route is APPENDED — calling twice with identical args creates a duplicate route. @ids are config-global in Caddy: if this id is already used by a non-route object the call refuses rather than clobbering it.
toYesUpstream addresses, at least one (e.g., ['localhost:3000', 'localhost:3001']). An 'https://' prefix dials the upstream over TLS (port 443 unless one is given); http:// and bare addresses are dialed in the clear. Do not mix https:// and non-https entries in one call.
fromYesDomain, path, or domain/path to match (e.g., 'api.local', '/api/*', 'app.local/ws')
serverNoCaddy server name (default: srv0)srv0

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations supply safety hints (destructiveHint=true, idempotentHint=false), and the description adds substantial context beyond them: conditional idempotency based on `id`, duplicate-route creation on repeat calls, refusal on non-route @id collision, server argument being ignored after @id registration, and TLS transport behavior. This is rich behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Dense and front-loaded with the primary purpose and example first, then edge cases. It is on the long side and repeats several schema-documented facts, but every sentence contributes operational detail rather than filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, non-idempotent mutation tool with no output schema, the description is thorough: it discloses idempotency semantics, collision refusal, cross-server @id behavior, and TLS handling. An agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all four parameters, including the @id collision behavior and the mixed-scheme restriction. The description largely restates those semantics, adding only a concrete example; baseline 3 is appropriate when the schema carries the load.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Add a reverse proxy route') and immediately scopes it as the most common operation. It also names caddy_add_route as the alternative for the mixed-scheme case, distinguishing it from siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly covers when to omit vs supply `id`, gives a hard recommendation for automation/production, explains the config-global @id scope, and routes the mixed-scheme case to caddy_add_route. When-to-use and when-not-to-use are both present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_revertA
Destructive

Manage config snapshots for rollback. Snapshots are auto-captured before caddy_load, and before a caddy_config_delete or caddy_config_set at the config root (any path that addresses the whole config), and before a caddy_config_by_id set or delete whose @id resolves to the root with no subpath (or a lone '...'); no other delete or set is snapshotted. Last 10. By default they live in memory only and are LOST when this server restarts -- set CADDY_MCP_SNAPSHOT_DIR to a writable directory to persist them across restarts (they contain full Caddy configs, so pick the location deliberately). Actions: 'list' shows snapshots with timestamps, 'save' manually captures the current config, 'apply' restores a snapshot (requires confirm=true).

NameRequiredDescriptionDefault
indexNoSnapshot index for 'apply' (0 = most recent, default)
actionYesAction to perform
confirmNoMust be true to actually apply a snapshot (safety)

TDQS

A5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations only declare destructiveHint=true, but the description adds crucial behavioral context: snapshots retain only the last 10, are memory-only by default and lost on restart, contain full Caddy configs, and apply requires confirm=true. This substantially exceeds what annotations alone communicate and helps the agent avoid destructive mistakes.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but every sentence earns its place, covering auto-capture rules, retention, persistence, safety, and the action enum. It front-loads the primary purpose before diving into edge-case behavior, making it scannable for an agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive tool with three parameters and no output schema, the description covers the full behavioral contract: what is snapshotted, retention limits, persistence options, safety confirmation, and how each action behaves. Nothing critical for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although the schema already describes all three parameters, the description enriches them: it defines what each action does, states that index 0 means most recent, and clarifies that confirm=true is a mandatory safety gate for apply. This adds real decision-making value beyond the raw schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a clear verb-resource pairing, 'Manage config snapshots for rollback,' and immediately distinguishes this tool from the config-mutation siblings by focusing on snapshot lifecycle. It then enumerates the exact actions (list, save, apply), removing any ambiguity about what the tool does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly states when snapshots are auto-captured, when they are not ('no other delete or set is snapshotted'), and how to manually invoke each action. It also gives an operational guideline for persistence via CADDY_MCP_SNAPSHOT_DIR, which is exactly the kind of conditional usage an agent needs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_statusA
Read-onlyIdempotent

Check Caddy connectivity and get a config summary: servers, routes, listen addresses, and TLS status.

NameRequiredDescriptionDefault

No parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safe read-only nature is clear. The description adds valuable context about what the summary contains (servers, routes, listen addresses, TLS status), going beyond the annotations. It does not discuss failure modes, but the annotation coverage lowers the bar and the added context is meaningful.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence that packs significant information: the verb ('Check'), the resource ('Caddy connectivity'), and a detailed summary content list. Every word earns its place, with no redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (no params, no output schema), the description is complete. It explains both the action (connectivity check) and the expected return content (config summary with servers, routes, listen addresses, TLS status). Rich annotations further cover the safety profile, so the description sufficiently covers all necessary contextual information.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the schema is trivially complete (coverage 100%). Per guidelines, 0 params receives a baseline score of 4 because there are no parameter gaps to address. The description adds no parameter info, but none is needed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb and resource: 'Check Caddy connectivity and get a config summary'. It also enumerates the summary content (servers, routes, listen addresses, TLS status), which distinguishes it from sibling tools like caddy_config_get (full config) and caddy_list_servers (specific server list).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by stating the tool provides connectivity checks and a config summary, but it does not explicitly recommend it over alternatives or mention when not to use it. It provides clear context for when this tool is appropriate, but lacks explicit exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_stopA
Destructive

Gracefully shut down the Caddy server. Requires confirm=true to prevent accidental shutdown.

NameRequiredDescriptionDefault
confirmYesMust be true to confirm shutdown

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds meaningful context by specifying 'gracefully' shutdown and the confirm=true safeguard, which helps the agent understand the manner and safety requirement of the operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the core action, and every word contributes value. There is no filler or redundant elaboration beyond the necessary confirmation note.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter stop operation with clear annotations and full schema coverage, the description is sufficient. It does not explain return values or edge cases, but given the low complexity and existing structured data, that is acceptable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema fully describes the confirm parameter with 100% coverage ('Must be true to confirm shutdown'). The description only repeats this requirement without adding new semantic detail, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'shut down' with a clear resource 'Caddy server', and it is distinct from sibling tools that handle config, status, or routes. The action and target are unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies its use (to stop the server) but does not explicitly state when to use it versus alternatives or when not to use it. The confirm requirement is a prerequisite, not a usage guideline. It lacks explicit context for selection among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_tlsA
Idempotent

Get or configure TLS/HTTPS settings. Actions: 'status' shows current TLS config, 'set_email' sets the ACME email, 'set_acme_ca' sets the ACME CA URL, 'set_acme_profile' sets the ACME profile (Caddy 2.10+), 'ech_status' reads the Encrypted ClientHello config at apps/tls/encrypted_client_hello (Caddy 2.10+, read-only here). Works on both fresh and existing Caddy instances, including one with no config at all: the set_* actions create apps/tls, and any missing parents, when it is not set. Writes target policies[0].issuers[0] only, and only when that issuer's module is 'acme' -- on a multi-policy TLS config, or one whose first issuer is 'internal' (Caddy's local CA), edit the intended issuer with caddy_config_set instead.

NameRequiredDescriptionDefault
caNoACME CA URL (for 'set_acme_ca' action)
emailNoACME email address (for 'set_email' action)
actionYesAction to perform
profileNoACME profile name (for 'set_acme_profile'). Requires Caddy 2.10+ and a CA that offers profiles; Let's Encrypt uses 'shortlived' for 6-day certificates. Valid names are defined by the CA, not by Caddy. EXPERIMENTAL upstream (the ACME profiles spec is still a draft; Caddy marks the field 'subject to change' and may rename or drop it). Caddy accepts any name on load, so a success here does not mean the CA offers it: if this issuer's CA does not advertise the name, every order from this issuer fails at issuance time, reported only in Caddy's own logs. Caddy then either falls through to the next issuer in the policy, which issues WITHOUT the profile, or -- when this is the policy's only issuer, which is the shape this tool creates -- keeps retrying and issues no certificate at all.

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Even though annotations already mark the tool as idempotent and non-destructive, the description reveals important side effects: set_* actions create apps/tls and missing parents, and writes only target policies[0].issuers[0] when that issuer's module is 'acme'. It also discloses version constraints (Caddy 2.10+), read-only behavior for ech_status, and the failure semantics of set_acme_profile when a CA does not support the profile.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is dense but every sentence contributes operational guidance: purpose, action list, version gates, creation behavior, and the alternative path. It is front-loaded with the main purpose and action enumeration, and the longer edge-case clauses earn their length.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers version requirements, fresh-vs-existing behavior, exact mutation targets, exclusions, and the alternative tool. The only notable gap is the lack of explicit return-value shape for status/ech_status, but since there is no output schema and the read actions are described as showing/reading config, this is a minor omission.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds value by explaining how the action parameter changes config: set_* creates missing parents and targets only the first issuer under specific conditions. It also reinforces the meaning of each action, though ca and email formats remain mostly handled by the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening line states a specific verb and resource: 'Get or configure TLS/HTTPS settings.' The description then enumerates the five actions, making the tool's scope unmistakable. It also differentiates from generic config tools by pointing to caddy_config_set as the fallback for unsupported TLS shapes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says when the tool is appropriate: 'Works on both fresh and existing Caddy instances, including one with no config at all.' It also gives a clear when-not-to-use rule by instructing that on multi-policy TLS configs or with an 'internal' first issuer, you should 'edit the intended issuer with caddy_config_set instead.'

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

caddy_upstreamsA
Read-onlyIdempotent

Caddy's /reverse_proxy/upstreams array (address, num_requests, fails), returned verbatim. On Caddy 2.11.2+ it is not the configured upstream list. Dynamic-upstream backends stay listed about 1 h (up to ~65 min) after the dynamic source last returned them, even after a config change removes them, so an address may appear that no current config references. A backend with requests in flight can appear twice when its resolved address differs from the entry's text (dynamic upstreams, tcp/ or unix// dials, placeholder dials). That extra copy always shows fails 0 and repeats num_requests, so do not sum num_requests across entries.

NameRequiredDescriptionDefault

No parameters

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (readOnlyHint, idempotentHint), the description discloses several non-obvious behaviors: the data is returned verbatim, it may not reflect the current config on certain versions, dynamic entries persist for a while, and duplicates can appear with specific characteristics. This is exactly the kind of behavioral context that prevents an agent from drawing wrong conclusions, and it does not contradict any annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and then expands into necessary caveats. It is longer than average, but every sentence adds unique operational value (version-specific behavior, persistence, duplication, summation warning). It is not wordy, though it could be tightened with bullet points for the caveats.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no parameters, the description carries the full burden of explaining what to expect from the tool. It covers the array shape, the fields per entry, the version caveat, the persistence timing, the duplicate-entry scenario, and the summing pitfall. This is sufficient for an agent to invoke the tool and interpret the result without being misled.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters and the schema has no properties, so there is nothing for the description to explain. Baseline for 0 params is 4. The description makes no parameter claims and correctly focuses on output behavior instead.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a precise statement of what the tool returns: Caddy's /reverse_proxy/upstreams array with the exact fields (address, num_requests, fails), returned verbatim. It also distinguishes this tool from configuration retrieval by noting that on Caddy 2.11.2+ it is not the configured upstream list, and the reader can infer it is meant for inspecting runtime upstream state.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context—it tells you when the data is misleading (after config changes, with dynamic upstreams) and warns against summing num_requests. However, it never explicitly says 'use this when you need runtime upstream statistics' or contrasts it with sibling tools like caddy_config_get. The caveats are useful but the when/why is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updatesv2.5.6
    • Changedcaddy_config_by_id1 field changed
      • changedInput schema / properties / confirm / description
        Previous value: -"Must be true to actually delete (only enforced for action='delete')"New value: +"Must be true to actually delete, and to 'set' when Caddy resolves `id` to the config root (that replaces the ENTIRE config). Ignored for every other 'set'."
    • Changedcaddy_config_set1 field changed
      • addedInput schema / properties / confirm
        Added value: +{
        +  "default": false,
        +  "description": "Must be true when `path` addresses the config root ('', '/', 'config', '/config/', slash-only variants, or a lone '...' segment): that write replaces the ENTIRE config (safety). Ignored for every other path.",
        +  "type": "boolean"
        +}
  2. 1 tool updatev2.5.4
    • Changedcaddy_tls1 field changed
      • changedInput schema / properties / profile / description
        Previous value: -"ACME profile name (for 'set_acme_profile'). Requires Caddy 2.10+ and a CA that offers profiles; Let's Encrypt uses 'shortlived' for 6-day certificates. Valid names are defined by the CA, not by Caddy."New value: +"ACME profile name (for 'set_acme_profile'). Requires Caddy 2.10+ and a CA that offers profiles; Let's Encrypt uses 'shortlived' for 6-day certificates. Valid names are defined by the CA, not by Caddy. EXPERIMENTAL upstream (the ACME profiles spec is still a draft; Caddy marks the field 'subject to change' and may rename or drop it). Caddy accepts any name on load, so a success here does not mean the CA offers it: if this issuer's CA does not advertise the name, every order from this issuer fails at issuance time, reported only in Caddy's own logs. Caddy then either falls through to the next issuer in the policy, which issues WITHOUT the profile, or -- when this is the policy's only issuer, which is the shape this tool creates -- keeps retrying and issues no certificate at all."
  3. 2 tool updatesv2.5.3
    • Changedcaddy_config_by_id1 field changed
      • changedInput schema / properties / mode / description
        Previous value: -"For 'set' action: 'overwrite' = PATCH (replace existing, default), 'append' = POST (add to arrays, create on objects), 'insert' = PUT (insert at array index)"New value: +"For 'set' action: 'overwrite' = PATCH (replace the identified object, or the value at subpath; default). 'append' = POST and 'insert' = PUT behave as in caddy_config_set at the resolved path: with a subpath into an array, POST appends and PUT inserts at the index; PUT also strictly creates an object key (409 if it exists). With NO subpath: for an array element (a route) neither replaces it — POST adds the value as a new element at the end of that array, PUT inserts it just before the identified one, and both are rejected with 'duplicate ID' if the value carries the same @id; for an object held under a key (a server) POST REPLACES it wholesale and PUT fails with 409. Use 'overwrite' to replace in place."
    • Changedcaddy_config_set1 field changed
      • changedInput schema / properties / mode / description
        Previous value: -"'overwrite' = PATCH (replace existing, default, idempotent), 'append' = POST (add to arrays / create keys, NOT idempotent), 'insert' = PUT (insert at array index)"New value: +"'overwrite' = PATCH (replace existing, default, idempotent; 404 if the key does not exist), 'append' = POST (appends to arrays, NOT idempotent; REPLACES an existing non-array key; cannot create missing parents), 'insert' = PUT (inserts at an array index, or strictly creates an object key and any missing parents; 409 if the key exists)"
  4. 1 tool updatev2.4.0
    • Changedcaddy_reverse_proxy3 fields changed
      • changedInput schema / properties / to / description
        Previous value: -"Upstream addresses (e.g., ['localhost:3000', 'localhost:3001'])"New value: +"Upstream addresses, at least one (e.g., ['localhost:3000', 'localhost:3001']). An 'https://' prefix dials the upstream over TLS (port 443 unless one is given); http:// and bare addresses are dialed in the clear. Do not mix https:// and non-https entries in one call."
      • addedInput schema / properties / to / items / minLength
        Added value: +1
      • addedInput schema / properties / to / minItems
        Added value: +1
  5. 1 tool updatev2.3.2
    • Changedcaddy_tls2 fields changed
      • changedInput schema / properties / action / enum
        Previous value: -[
        -  "status",
        -  "set_email",
        -  "set_acme_ca"
        -]New value: +[
        +  "status",
        +  "set_email",
        +  "set_acme_ca",
        +  "set_acme_profile",
        +  "ech_status"
        +]
      • addedInput schema / properties / profile
        Added value: +{
        +  "description": "ACME profile name (for 'set_acme_profile'). Requires Caddy 2.10+ and a CA that offers profiles; Let's Encrypt uses 'shortlived' for 6-day certificates. Valid names are defined by the CA, not by Caddy.",
        +  "type": "string"
        +}
  6. 18 tool updatesv2.2.0
    • First observedcaddy_adapt
    • First observedcaddy_add_route
    • First observedcaddy_config_by_id
    • First observedcaddy_config_delete
    • First observedcaddy_config_get
    • First observedcaddy_config_set
    • First observedcaddy_list_routes
    • First observedcaddy_list_servers
    • First observedcaddy_load
    • First observedcaddy_metrics
    • First observedcaddy_pki
    • First observedcaddy_remove_route
    • First observedcaddy_reverse_proxy
    • First observedcaddy_revert
    • First observedcaddy_status
    • First observedcaddy_stop
    • First observedcaddy_tls
    • First observedcaddy_upstreams

TDQS

A4.2/5.0

Scored across 18 tools

Disambiguation4/5

Multiple tools can write config (caddy_config_set, caddy_config_by_id, caddy_load, caddy_add_route, caddy_reverse_proxy), and delete overlaps similarly (caddy_config_delete vs caddy_remove_route), so boundaries are not perfectly clean. However, the descriptions go to great lengths to explain when each applies (low-level path vs @id vs convenience wrapper), making selection tractable for an agent.

Naming Consistency4/5

Every tool carries the caddy_ prefix in consistent snake_case, forming recognizable families (config_get/set/delete, list_servers/routes, add_route/remove_route). Minor deviation: several tools are bare nouns (caddy_status, caddy_metrics, caddy_upstreams, caddy_pki) rather than verb_noun, but the overall pattern is predictable.

Tool Count4/5

18 tools is on the heavier side but each earns a place, spanning config CRUD, route helpers, snapshots, TLS/PKI, metrics, and lifecycle. Slightly over what a minimal config server would need, but well-scoped for Caddy's breadth.

Completeness5/5

The surface covers the full config lifecycle (read, write, delete, whole-config load, snapshot/revert), route management, TLS/PKI configuration, observability (metrics, upstreams), format adaptation, and graceful shutdown. No obvious dead ends for administering Caddy via its admin API.

Maintenance

ActivityActive
ResponsivenessUnresponsive

Related MCP Connectors

Related MCP Servers