render-automation

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Render Automation via Rube MCP

通过Rube MCP实现Render自动化

Automate Render cloud platform operations through Composio's Render toolkit via Rube MCP.
通过Composio的Render工具包,借助Rube MCP自动化Render云平台的操作。

Prerequisites

前提条件

  • Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
  • Active Render connection via
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    render
  • Always call
    RUBE_SEARCH_TOOLS
    first to get current tool schemas
  • 必须已连接Rube MCP(需确保RUBE_SEARCH_TOOLS可用)
  • 通过
    RUBE_MANAGE_CONNECTIONS
    并使用工具包
    render
    建立有效的Render连接
  • 请始终先调用
    RUBE_SEARCH_TOOLS
    以获取最新的工具模式

Setup

设置步骤

Get Rube MCP: Add
https://rube.app/mcp
as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.
  1. Verify Rube MCP is available by confirming
    RUBE_SEARCH_TOOLS
    responds
  2. Call
    RUBE_MANAGE_CONNECTIONS
    with toolkit
    render
  3. If connection is not ACTIVE, follow the returned auth link to complete Render authentication
  4. Confirm connection status shows ACTIVE before running any workflows
获取Rube MCP:在客户端配置中添加
https://rube.app/mcp
作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。
  1. 通过确认
    RUBE_SEARCH_TOOLS
    能正常响应,验证Rube MCP是否可用
  2. 调用
    RUBE_MANAGE_CONNECTIONS
    并指定工具包
    render
  3. 如果连接状态未显示为ACTIVE,请按照返回的认证链接完成Render身份验证
  4. 在运行任何工作流之前,确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. List and Browse Services

1. 列出并浏览服务

When to use: User wants to find or inspect Render services (web services, static sites, workers, cron jobs)
Tool sequence:
  1. RENDER_LIST_SERVICES
    - List all services with optional filters [Required]
Key parameters:
  • name
    : Filter services by name substring
  • type
    : Filter by service type ('web_service', 'static_site', 'private_service', 'background_worker', 'cron_job')
  • limit
    : Maximum results per page (default 20, max 100)
  • cursor
    : Pagination cursor from previous response
Pitfalls:
  • Service types must match exact enum values: 'web_service', 'static_site', 'private_service', 'background_worker', 'cron_job'
  • Pagination uses cursor-based approach; follow
    cursor
    until absent
  • Name filter is substring-based, not exact match
  • Service IDs follow the format 'srv-xxxxxxxxxxxx'
  • Default limit is 20; set higher for comprehensive listing
适用场景:用户想要查找或查看Render服务(Web服务、静态站点、工作进程、定时任务)
工具执行顺序:
  1. RENDER_LIST_SERVICES
    - 列出所有服务,可选择使用过滤器 [必填]
关键参数:
  • name
    : 根据名称子串过滤服务
  • type
    : 根据服务类型过滤(可选值:'web_service'、'static_site'、'private_service'、'background_worker'、'cron_job')
  • limit
    : 每页最大结果数(默认20,最大100)
  • cursor
    : 来自上一次响应的分页游标
注意事项:
  • 服务类型必须完全匹配枚举值:'web_service'、'static_site'、'private_service'、'background_worker'、'cron_job'
  • 分页采用基于游标的方式;需持续使用返回的
    cursor
    直到其不存在
  • 名称过滤器是基于子串匹配,而非精确匹配
  • 服务ID格式为'srv-xxxxxxxxxxxx'
  • 默认限制为20;若需完整列表可设置更高值

2. Trigger Deployments

2. 触发部署

When to use: User wants to manually deploy or redeploy a service
Tool sequence:
  1. RENDER_LIST_SERVICES
    - Find the service to deploy [Prerequisite]
  2. RENDER_TRIGGER_DEPLOY
    - Trigger a new deployment [Required]
  3. RENDER_RETRIEVE_DEPLOY
    - Monitor deployment progress [Optional]
Key parameters:
  • For TRIGGER_DEPLOY:
    • serviceId
      : Service ID to deploy (required, format: 'srv-xxxxxxxxxxxx')
    • clearCache
      : Set
      true
      to clear build cache before deploying
  • For RETRIEVE_DEPLOY:
    • serviceId
      : Service ID
    • deployId
      : Deploy ID from trigger response (format: 'dep-xxxxxxxxxxxx')
Pitfalls:
  • serviceId
    is required; resolve via LIST_SERVICES first
  • Service IDs start with 'srv-' prefix
  • Deploy IDs start with 'dep-' prefix
  • clearCache: true
    forces a clean build; takes longer but resolves cache-related issues
  • Deployment is asynchronous; use RETRIEVE_DEPLOY to poll status
  • Triggering a deploy while another is in progress may queue the new one
适用场景:用户想要手动部署或重新部署服务
工具执行顺序:
  1. RENDER_LIST_SERVICES
    - 找到要部署的服务 [前置步骤]
  2. RENDER_TRIGGER_DEPLOY
    - 触发新的部署 [必填]
  3. RENDER_RETRIEVE_DEPLOY
    - 监控部署进度 [可选]
关键参数:
  • 对于TRIGGER_DEPLOY:
    • serviceId
      : 要部署的服务ID(必填,格式:'srv-xxxxxxxxxxxx')
    • clearCache
      : 设置为
      true
      可在部署前清除构建缓存
  • 对于RETRIEVE_DEPLOY:
    • serviceId
      : 服务ID
    • deployId
      : 触发部署响应中的部署ID(格式:'dep-xxxxxxxxxxxx')
注意事项:
  • serviceId
    为必填项;需先通过LIST_SERVICES获取
  • 服务ID以'srv-'为前缀
  • 部署ID以'dep-'为前缀
  • clearCache: true
    会强制执行干净构建;耗时更长但可解决缓存相关问题
  • 部署是异步操作;需使用RETRIEVE_DEPLOY轮询状态
  • 若在已有部署进行时触发新部署,新部署可能会进入队列

3. Monitor Deployment Status

3. 监控部署状态

When to use: User wants to check the progress or result of a deployment
Tool sequence:
  1. RENDER_RETRIEVE_DEPLOY
    - Get deployment details and status [Required]
Key parameters:
  • serviceId
    : Service ID (required)
  • deployId
    : Deployment ID (required)
  • Response includes
    status
    ,
    createdAt
    ,
    updatedAt
    ,
    finishedAt
    ,
    commit
Pitfalls:
  • Both
    serviceId
    and
    deployId
    are required
  • Deploy statuses include: 'created', 'build_in_progress', 'update_in_progress', 'live', 'deactivated', 'build_failed', 'update_failed', 'canceled'
  • 'live' indicates successful deployment
  • 'build_failed' or 'update_failed' indicate deployment errors
  • Poll at reasonable intervals (10-30 seconds) to avoid rate limits
适用场景:用户想要检查部署的进度或结果
工具执行顺序:
  1. RENDER_RETRIEVE_DEPLOY
    - 获取部署详情和状态 [必填]
关键参数:
  • serviceId
    : 服务ID(必填)
  • deployId
    : 部署ID(必填)
  • 响应包含
    status
    createdAt
    updatedAt
    finishedAt
    commit
    字段
注意事项:
  • serviceId
    deployId
    均为必填项
  • 部署状态包括:'created'、'build_in_progress'、'update_in_progress'、'live'、'deactivated'、'build_failed'、'update_failed'、'canceled'
  • 'live'表示部署成功
  • 'build_failed'或'update_failed'表示部署出错
  • 需以合理间隔(10-30秒)轮询,避免触发速率限制

4. Manage Projects

4. 管理项目

When to use: User wants to list and organize Render projects
Tool sequence:
  1. RENDER_LIST_PROJECTS
    - List all projects [Required]
Key parameters:
  • limit
    : Maximum results per page (max 100)
  • cursor
    : Pagination cursor from previous response
Pitfalls:
  • Projects group related services together
  • Pagination uses cursor-based approach
  • Project IDs are used for organizational purposes
  • Not all services may be assigned to a project
适用场景:用户想要列出并管理Render项目
工具执行顺序:
  1. RENDER_LIST_PROJECTS
    - 列出所有项目 [必填]
关键参数:
  • limit
    : 每页最大结果数(最大100)
  • cursor
    : 来自上一次响应的分页游标
注意事项:
  • 项目用于将相关服务分组
  • 分页采用基于游标的方式
  • 项目ID用于组织管理
  • 并非所有服务都必须分配到项目中

Common Patterns

通用模式

ID Resolution

ID解析

Service name -> Service ID:
1. Call RENDER_LIST_SERVICES with name=service_name
2. Find service by name in results
3. Extract id (format: 'srv-xxxxxxxxxxxx')
Deployment lookup:
1. Store deployId from RENDER_TRIGGER_DEPLOY response
2. Call RENDER_RETRIEVE_DEPLOY with serviceId and deployId
3. Check status for completion
服务名称 -> 服务ID:
1. 调用RENDER_LIST_SERVICES,参数name=service_name
2. 在结果中按名称查找服务
3. 提取id(格式:'srv-xxxxxxxxxxxx')
部署查询:
1. 保存RENDER_TRIGGER_DEPLOY响应中的deployId
2. 调用RENDER_RETRIEVE_DEPLOY,传入serviceId和deployId
3. 检查状态是否完成

Deploy and Monitor Pattern

部署与监控模式

1. RENDER_LIST_SERVICES -> find service by name -> get serviceId
2. RENDER_TRIGGER_DEPLOY with serviceId -> get deployId
3. Loop: RENDER_RETRIEVE_DEPLOY with serviceId + deployId
4. Check status: 'live' = success, 'build_failed'/'update_failed' = error
5. Continue polling until terminal state reached
1. RENDER_LIST_SERVICES -> 按名称查找服务 -> 获取serviceId
2. 使用serviceId调用RENDER_TRIGGER_DEPLOY -> 获取deployId
3. 循环:调用RENDER_RETRIEVE_DEPLOY,传入serviceId + deployId
4. 检查状态:'live' = 成功,'build_failed'/'update_failed' = 错误
5. 持续轮询直到达到最终状态

Pagination

分页

  • Use
    cursor
    from response for next page
  • Continue until
    cursor
    is absent or results are empty
  • Both LIST_SERVICES and LIST_PROJECTS use cursor-based pagination
  • Set
    limit
    to max (100) for fewer pagination rounds
  • 使用响应中的
    cursor
    获取下一页内容
  • 持续操作直到
    cursor
    不存在或结果为空
  • LIST_SERVICES和LIST_PROJECTS均使用基于游标的分页
  • limit
    设置为最大值(100)以减少分页次数

Known Pitfalls

已知注意事项

Service IDs:
  • Always prefixed with 'srv-' (e.g., 'srv-abcd1234efgh')
  • Deploy IDs prefixed with 'dep-' (e.g., 'dep-d2mqkf9r0fns73bham1g')
  • Always resolve service names to IDs via LIST_SERVICES
Service Types:
  • Must use exact enum values when filtering
  • Available types: web_service, static_site, private_service, background_worker, cron_job
  • Different service types have different deployment behaviors
Deployment Behavior:
  • Deployments are asynchronous; always poll for completion
  • Clear cache deploys take longer but resolve stale cache issues
  • Failed deploys do not roll back automatically; the previous version stays live
  • Concurrent deploy triggers may be queued
Rate Limits:
  • Render API has rate limits
  • Avoid rapid polling; use 10-30 second intervals
  • Bulk operations should be throttled
Response Parsing:
  • Response data may be nested under
    data
    key
  • Timestamps use ISO 8601 format
  • Parse defensively with fallbacks for optional fields
服务ID:
  • 始终以'srv-'为前缀(例如:'srv-abcd1234efgh')
  • 部署ID以'dep-'为前缀(例如:'dep-d2mqkf9r0fns73bham1g')
  • 必须始终通过LIST_SERVICES将服务名称解析为ID
服务类型:
  • 过滤时必须使用精确的枚举值
  • 可用类型:web_service、static_site、private_service、background_worker、cron_job
  • 不同服务类型的部署行为不同
部署行为:
  • 部署是异步操作;必须始终轮询以确认完成
  • 清除缓存的部署耗时更长,但可解决缓存过期问题
  • 部署失败不会自动回滚;上一版本会保持在线状态
  • 并发触发的部署可能会进入队列
速率限制:
  • Render API存在速率限制
  • 避免频繁轮询;使用10-30秒的间隔
  • 批量操作应进行限流
响应解析:
  • 响应数据可能嵌套在
    data
    键下
  • 时间戳采用ISO 8601格式
  • 解析时需带有容错机制,处理可选字段

Quick Reference

快速参考

TaskTool SlugKey Params
List servicesRENDER_LIST_SERVICESname, type, limit, cursor
Trigger deployRENDER_TRIGGER_DEPLOYserviceId, clearCache
Get deploy statusRENDER_RETRIEVE_DEPLOYserviceId, deployId
List projectsRENDER_LIST_PROJECTSlimit, cursor
任务工具标识关键参数
列出服务RENDER_LIST_SERVICESname, type, limit, cursor
触发部署RENDER_TRIGGER_DEPLOYserviceId, clearCache
获取部署状态RENDER_RETRIEVE_DEPLOYserviceId, deployId
列出项目RENDER_LIST_PROJECTSlimit, cursor