Coolify logoCoolify

MCP 服务器

Coolify 内置了一个 MCP(模型上下文协议)服务器,允许 AI 助手查询您的 Coolify 实例,而无需暴露敏感凭据。

目前仅支持只读

MCP 服务器目前仅支持只读,写入操作计划在未来的版本中提供。

适用人群

此设置非常适合以下人群:

  • 使用 AI 编码助手,如 Claude CodeCursorCodex 等,并希望它们了解您的基础设施。
  • 希望用自然语言询问有关已部署应用、数据库和服务器的信息。
  • 需要从 AI 工具中查看您的 Coolify 资源的只读视图,同时避免意外更改的风险。
  • 管理多个项目,并希望 AI 帮助导航您的基础设施。

开始之前

需要 API 访问权限

MCP 依赖 API 令牌进行身份验证。

在启用 MCP 服务器之前,请确保您的实例已启用 API 访问

您可以按照 API 设置 指南来启用它。


工作原理

您的 AI 助手使用标准 API 令牌通过 HTTP 连接到 Coolify 的 MCP 端点。连接后,助手可以调用 10 个内置工具中的任何一个来浏览您的基础设施——列出服务器、检查应用程序、查看数据库状态等。

所有数据都限定在与您的 API 令牌关联的团队范围内。如果您有多个团队,助手只能看到属于该令牌所属团队的资源。


示例数据

以下数据在本指南中用作示例。请按照步骤操作时将其替换为您的实际数据。


1. 启用 MCP 服务器

您可以从仪表板启用或禁用 MCP 服务器:

  1. 登录到您的 Coolify 仪表板
  2. 进入侧边栏中的设置
  3. 点击高级
  4. 找到 MCP 服务器部分并开启 启用 MCP 服务器开关。

您可以使用 API 以编程方式启用或禁用 MCP 服务器:

# 启用 MCP
curl -X POST https://coolify.shadowarcanist.com/api/v1/mcp/enable \
  -H "Authorization: Bearer 67|abcthisisa123dummytoken"

# 禁用 MCP
curl -X POST https://coolify.shadowarcanist.com/api/v1/mcp/disable \
  -H "Authorization: Bearer 67|abcthisisa123dummytoken"

这些端点需要具有 root 权限的 API 令牌。

启用后,您的 MCP 端点将变为可用:

https://coolify.shadowarcanist.com/mcp

2. 创建 API 令牌

MCP 服务器使用您现有的 Coolify API 令牌进行身份验证。请按照 API 授权指南 创建令牌。

您的令牌必须具有 read 权限。

令牌权限

目前您的 MCP 令牌只需要 read 权限。

由于服务器目前仅支持只读操作,额外的权限不会带来任何好处,并且如果令牌泄露会增加风险。

3. 配置您的 AI 客户端

使用您的 MCP 端点和 API 令牌连接您的 AI 助手。

Coolify 的 MCP 服务器使用 Streamable HTTP 传输。

在配置任何客户端时,您需要:

  • URL: https://coolify.shadowarcanist.com/mcp
  • 身份验证头: Authorization: Bearer 67|abcthisisa123dummytoken

请按照您客户端的设置指南进行操作:

任何支持 Streamable HTTP 传输的其他 MCP 兼容客户端也可以使用上述 URL 和身份验证头进行连接。


可用工具

连接后,您的 AI 助手可以使用以下 10 个工具。所有工具目前均为只读。

概览

工具描述
get_infrastructure_overview整个基础设施的高级摘要——从这里开始

服务器

工具描述
list_servers列出所有服务器,包括名称、IP 和可达性状态
get_server通过 UUID 获取特定服务器的详细信息

项目

工具描述
list_projects列出所有项目,包括名称和描述

应用程序

工具描述
list_applications列出所有应用程序(可按标签筛选)
get_application通过 UUID 获取特定应用程序的详细信息

数据库

工具描述
list_databases列出所有数据库,包括名称、状态和类型
get_database通过 UUID 获取特定数据库的详细信息

服务

工具描述
list_services列出所有一键式服务和堆栈
get_service通过 UUID 获取特定服务的详细信息

推荐工作流程

首先使用 get_infrastructure_overview 获取设置的全局视图。

然后使用 list_* 工具浏览特定资源类型,并在需要特定资源的详细信息时使用 get_* 工具。

分页

所有 list_* 工具都支持分页:

  • page — 页码(默认值:1)
  • per_page — 每页项目数(默认值:50,最大值:100)

响应中包含一个 _pagination 字段,其中包含指示下一页的 next 值(如果可用)。


安全注意事项

您的基础设施元数据(服务器 IP、应用程序名称、域名、环境变量名称)对 AI 客户端可见。

撤销用于 MCP 的 API 令牌会立即切断 MCP 访问。


故障排除

On this page