Skip to content
Back to search

render-mcp-server

The Official Render MCP Server

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/render-oss/render-mcp-server with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/render-oss/render-mcp-server'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/render-oss--render-mcp-server/badge.svg)](/listings/render-oss--render-mcp-server)

HTML

<a href="/listings/render-oss--render-mcp-server"><img src="/api/listings/render-oss--render-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 612 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Render MCP Server
  2. ## Overview
  3. The Render MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
  4. server that allows you to interact with your Render resources via LLMs.
  5. ## Getting Started
  6. Get started with the MCP server by following the official docs: https://render.com/docs/mcp-server
  7. ## Logging
  8. Application logs are written as JSON to stderr. Set `LOG_LEVEL` to `DEBUG`, `INFO`, `WARN`, or
  9. `ERROR` to control verbosity; the default is `INFO`. Invalid levels fail startup.
  10. HTTP access logs, Render API error responses, expected SDK request failures, tool diagnostics,
  11. and HTTP SDK transport informational messages are emitted at `DEBUG`.
  12. Unexpected server failures are emitted at `ERROR`.
  13. Set `TOOL_CALL_LOG_LEVEL` to choose the severity of tool-call completion events. It defaults
  14. to `DEBUG`; set it to `INFO` to collect completion events without enabling DEBUG diagnostics.
  15. `LOG_LEVEL` still filters these events. Empty or invalid values fall back to `DEBUG`, with
  16. a startup warning for invalid input. The setting is read once at startup.
  17. ## Protocol Support
  18. The server supports Streamable HTTP and stdio with MCP protocol versions
  19. `2025-11-25`, `2025-06-18`, `2025-03-26`, and `2024-11-05`.
  20. Stdio also supports the sessionless protocol `2026-07-28`. Streamable HTTP
  21. requires the initialize handshake with one of the versions listed above.
  22. ## Use Cases
  23. - Creating and managing web services, static sites, cron jobs, and databases on Render
  24. - Monitoring application logs and deployment status to help troubleshoot issues
  25. - Monitoring service performance metrics for debugging, capacity planning, and optimization
  26. - Querying your Postgres databases directly inside an LLM
  27. ## Feedback
  28. Please leave feedback via
  29. [filing a GitHub issue](https://github.com/render-oss/render-mcp-server/issues) if you have any
  30. feature requests, bug reports, suggestions, comments, or concerns.
  31. ## Tools
  32. ### Workspaces
  33. - **list_workspaces** - List the workspaces that you have access to
  34. - No parameters required
  35. - **select_workspace** - Select a workspace to use
  36. - `ownerID`: The ID of the workspace to select (string, required). Kept as `ownerID` so
  37. existing callers of this deprecated tool keep working; new code should pass `workspaceId`
  38. on each resource tool call instead.
  39. - **get_selected_workspace** - Get the currently selected workspace
  40. - No parameters required
  41. Every resource tool also accepts an optional `workspaceId`. After the user confirms a workspace from
  42. `list_workspaces`, pass that `workspaceId` on each related tool call. This keeps the target workspace
  43. explicit across MCP reconnects and transport-session changes. If `workspaceId` is omitted, the server
  44. temporarily falls back to the workspace selected in the current MCP session. That implicit
  45. session-based behavior is deprecated and is scheduled for removal.
  46. ### Services
  47. - **list_services** - List all services in your Render account
  48. - `includePreviews`: Whether to include preview services, defaults to false (boolean, optional)
  49. - **get_service** - Get details about a specific service
  50. - `serviceId`: The ID of the service to retrieve (string, required)
  51. - **create_web_service** - Create a new web service in your Render account
  52. - `name`: A unique name for your service (string, required)
  53. - `runtime`: Runtime environment for your service (string, required). Accepted values:
  54. - `node`
  55. - `python`
  56. - `go`
  57. - `rust`
  58. - `ruby`
  59. - `elixir`
  60. - `docker`
  61. - `buildCommand`: Command used to build your service (string, required unless runtime is `docker`)
  62. - `startCommand`: Command used to start your service (string, required unless runtime is `docker`)
  63. - `dockerfilePath`: Path to the Dockerfile relative to the repository root (string, optional). Defaults to `./Dockerfile`. Applies when runtime is `docker`.
  64. - `dockerContext`: Build context directory relative to the repository root (string, optional). Defaults to `.`. Applies when runtime is `docker`.
  65. - `dockerCommand`: Override for the image's startup command (string, optional). When omitted, uses the Dockerfile's `ENTRYPOINT` and `CMD`. An empty string also uses that default. Applies when runtime is `docker`.
  66. - `repo`: Repository containing source code (string, optional)
  67. - `branch`: Repository branch to deploy (string, optional)
  68. - `plan`: Plan for your service (string, optional). Accepted values:
  69. - `starter`
  70. - `standard`
  71. - `pro`
  72. - `pro_max`
  73. - `pro_plus`
  74. - `pro_ultra`
  75. - `autoDeploy`: Whether to automatically deploy the service (string, optional). Defaults to `yes`. Accepted values:
  76. - `yes`: Enable automatic deployments
  77. - `no`: Disable automatic deployments
  78. - `region`: Geographic region for deployment (string, optional). Defaults to `oregon`. Accepted values:
  79. - `oregon`
  80. - `frankfurt`
  81. - `singapore`
  82. - `ohio`
  83. - `virginia`
  84. - `envVars`: Environment variables array (array, optional)
  85. Deploying prebuilt images from a container registry is not supported.
  86. - **create_static_site** - Create a new static site in your Render account
  87. - `name`: A unique name for your service (string, required)
  88. - `buildCommand`: Command to build your app (string, required)
  89. - `repo`: Repository containing source code (string, optional)
  90. - `branch`: Repository branch to deploy (string, optional)
  91. - `autoDeploy`: Whether to automatically deploy the service (string, optional). Defaults to `yes`. Accepted values:
  92. - `yes`: Enable automatic deployments
  93. - `no`: Disable automatic deployments
  94. - `publishPath`: Directory containing built assets (string, optional)
  95. - `envVars`: Environment variables array (array, optional)
  96. - **create_cron_job** - Create a new cron job in your Render account
  97. - `name`: A unique name for your cron job (string, required)
  98. - `schedule`: Cron schedule expression (string, required). Uses standard cron syntax with 5 fields: minute (0-59), hour (0-23), day of month (1-31), month (1-12), day of week (0-6, Sunday=0). Examples:
  99. - `0 0 * * *`: Daily at midnight
  100. - `*/15 * * * *`: Every 15 minutes
  101. - `0 9 * * 1-5`: Weekdays at 9am
  102. - `0 0 1 * *`: First day of each month at midnight
  103. - `runtime`: Runtime environment for your cron job (string, required). Accepted values:
  104. - `node`
  105. - `python`
  106. - `go`
  107. - `rust`
  108. - `ruby`
  109. - `elixir`
  110. - `docker`
  111. - `buildCommand`: Command used to build your cron job (string, required unless runtime is `docker`)
  112. - `startCommand`: Command that runs when your cron job executes (string, required unless runtime is `docker`)
  113. - `dockerfilePath`: Path to the Dockerfile relative to the repository root (string, optional). Defaults to `./Dockerfile`. Applies when runtime is `docker`.
  114. - `dockerContext`: Build context directory relative to the repository root (string, optional). Defaults to `.`. Applies when runtime is `docker`.
  115. - `dockerCommand`: Override for the image's startup command (string, optional). When omitted, uses the Dockerfile's `ENTRYPOINT` and `CMD`. An empty string also uses that default. Applies when runtime is `docker`.
  116. - `repo`: Repository containing source code (string, optional)
  117. - `branch`: Repository branch to deploy (string, optional)
  118. - `plan`: Plan for your cron job (string, optional). Accepted values:
  119. - `starter`
  120. - `standard`
  121. - `pro`
  122. - `pro_max`
  123. - `pro_plus`
  124. - `pro_ultra`
  125. - `autoDeploy`: Whether to automatically deploy the cron job (string, optional). Defaults to `yes`. Accepted values:
  126. - `yes`: Enable automatic deployments
  127. - `no`: Disable automatic deployments
  128. - `region`: Geographic region for deployment (string, optional). Defaults to `oregon`. Accepted values:
  129. - `oregon`
  130. - `frankfurt`
  131. - `singapore`
  132. - `ohio`
  133. - `virginia`
  134. - `envVars`: Environment variables array (array, optional)
  135. Deploying prebuilt images from a container registry is not supported.
  136. - **run_cron_job** - Start a run of a cron job now, outside its schedule. The run uses the currently deployed build; it does not deploy new code. A cron job runs one run at a time and starting a new run cancels the one in progress, so this tool refuses while a run is in progress unless `cancelActiveRun` is `true`. Returns the new run (usually `pending`) and any run it canceled. Waits up to about 20 seconds for the run to be recorded as started, and adds a `warning` to the result if it is not.
  137. - `serviceId`: The ID of the cron job to run (string, required)
  138. - `cancelActiveRun`: Whether to cancel an in-progress run so the new run can start (boolean, optional). Defaults to `false`.
  139. - **cancel_cron_job_run** - Cancel the in-progress run of a cron job. The schedule is unaffected.
  140. - `serviceId`: The ID of the cron job (string, required)
  141. - **update_environment_variables** - Update all environment variables for a service
  142. - `serviceId`: The ID of the service to update (string, required)
  143. - `envVars`: Complete list of environment variables (array, required)
  144. - **update_web_service** - Direct updates to a web service are not supported through the MCP server. This tool returns a link to the service's settings in the Render Dashboard, where changes can be made (or via the [Render API](https://render.com/docs/api-reference)).
  145. - `serviceId`: The ID of the service to update (string, required)
  146. - **update_static_site** - Direct updates to a static site are not supported through the MCP server. This tool returns a link to the site's settings in the Render Dashboard, where changes can be made (or via the [Render API](https://render.com/docs/api-reference)).
  147. - `serviceId`: The ID of the service to update (string, required)
  148. - **update_cron_job** - Direct updates to a cron job are not supported through the MCP server. This tool returns a link to the cron job's settings in the Render Dashboard, where changes can be made (or via the [Render API](https://render.com/docs/api-reference)).
  149. - `serviceId`: The ID of the service to update (string, required)
  150. ### Deployments
  151. - **list_deploys** - List deployment history for a service
  152. - `serviceId`: The ID of the service to get deployments for (string, required)
  153. - **get_deploy** - Get details about a specific deployment
  154. - `serviceId`: The ID of the service (string, required)
  155. - `deployId`: The ID of the deployment (string, required)
  156. - **trigger_deploy** - Trigger a new deploy for a service. Services with autoDeploy enabled deploy automatically on push; use this for deploys that won't happen automatically.
  157. - `serviceId`: The ID of the service to deploy (string, required)
  158. - `clearCache`: Whether to clear the build cache before deploying (boolean, optional). Defaults to `false`.
  159. ### Events
  160. - **list_events** - List a service's event history: deploys, builds, restarts, failures, scaling, suspensions, and disk changes. Failure events carry the reason a service went down (out-of-memory kills, non-zero exits, failed health checks, evictions), which does not appear in logs.
  161. - `serviceId`: The ID of the service to list events for (string, required)
  162. - `eventTypes`: Filter to specific event types (array of strings, optional). Returns all types when omitted. Accepted values:
  163. - Build and deploy: `build_started`, `build_ended`, `deploy_started`, `deploy_ended`, `pre_deploy_started`, `pre_deploy_ended`, `initial_deploy_hook_started`, `initial_deploy_hook_ended`, `zero_downtime_redeploy_started`, `zero_downtime_redeploy_ended`, `commit_ignored`, `branch_deleted`, `image_pull_failed`, `artifact_fetch_failed`, `artifact_source_changed`, `auto_deploy_enabled`, `auto_deploy_disabled`, `pipeline_minutes_exhausted`
  164. - Runtime health: `server_available`, `server_failed`, `server_hardware_failure`, `server_restarted`
  165. - Scaling and plan: `autoscaling_started`, `autoscaling_ended`, `autoscaling_config_changed`, `instance_count_changed`, `plan_changed`
  166. - Disk: `disk_created`, `disk_updated`, `disk_deleted`, `disk_snapshot_restored`, `service_disk_usage_high`, `service_disk_usage_recovered`
  167. - Lifecycle and maintenance: `service_suspended`, `service_resumed`, `suspender_added`, `suspender_removed`, `maintenance_started`, `maintenance_ended`, `maintenance_mode_enabled`, `maintenance_mode_uri_updated`
  168. - Job runs: `cron_job_run_started`, `cron_job_run_ended`, `job_run_ended`
  169. - `startTime`: Start of the time range (RFC3339 format) (string, optional). Defaults to 7 days ago on the first page. Set it to reach events older than that.
  170. - `endTime`: End of the time range (RFC3339 format) (string, optional). Defaults to the current time.
  171. - `limit`: Maximum number of events to return, newest first (number, optional, min 1, max 100). Defaults to `20`.
  172. - `cursor`: A unique string that corresponds to a position in the result list. If provided, the endpoint returns results that appear after the corresponding position. To fetch the first page of results, set to the empty string (string, optional).
  173. Events cover services only, not Postgres or Key Value instances. The 7 day default applies to the first page only. For older events, page with the `cursor` from the previous call; if the first page comes back empty there is no cursor to follow, so set an earlier `startTime` instead.
  174. ### Logs
  175. - **list_logs** - List logs matching the provided filters
  176. - `resource`: Filter logs by their resource (array of strings, required)
  177. - `level`: Filter logs by their severity level (array of strings, optional)
  178. - `type`: Filter logs by their type (array of strings, optional)
  179. - `task`: Filter workflow logs by task or flow ID; requires the workflow ID in `resource` (array of strings, optional)
  180. - `taskRun`: Filter workflow logs by task run or flow run ID; requires the workflow ID in `resource` (array of strings, optional)
  181. - `instance`: Filter logs by the instance they were emitted from (array of strings, optional)
  182. - `host`: Filter request logs by their host (array of strings, optional)
  183. - `statusCode`: Filter request logs by their status code (array of strings, optional)
  184. - `method`: Filter request logs by their requests method (array of strings, optional)
  185. - `path`: Filter request logs by their path (array of strings, optional)
  186. - `text`: Filter by the text of the logs (array of strings, optional)
  187. - `startTime`: Start time for log query (RFC3339 format) (string, optional)
  188. - `endTime`: End time for log query (RFC3339 format) (string, optional)
  189. - `direction`: The direction to query logs for (string, optional)
  190. - `limit`: Maximum number of logs to return (number, optional)
  191. - **list_log_label_values** - List all values for a given log label in the logs matching the provided filters
  192. - `label`: The label to list values for (string, required)
  193. - `resource`: Filter by resource (array of strings, required)
  194. - `level`: Filter logs by their severity level (array of strings, optional)
  195. - `type`: Filter logs by their type (array of strings, optional)
  196. - `instance`: Filter logs by the instance they were emitted from (array of strings, optional)
  197. - `host`: Filter request logs by their host (array of strings, optional)
  198. - `statusCode`: Filter request logs by their status code (array of strings, optional)
  199. - `method`: Filter request logs by their requests method (array of strings, optional)
  200. - `path`: Filter request logs by their path (array of strings, optional)
  201. - `text`: Filter by the text of the logs (array of strings, optional)
  202. - `startTime`: Start time for log query (RFC3339 format) (string, optional)
  203. - `endTime`: End time for log query (RFC3339 format) (string, optional)
  204. - `direction`: The direction to query logs for (string, optional)
  205. ### Metrics
  206. - **get_metrics** - Get performance metrics for any Render resource (services, Postgres databases, key-value stores). Metrics may be empty if the metric is not valid for the given resource
  207. - `resourceId`: The ID of the resource to get metrics for (service ID, Postgres ID, or key-value store ID) (string, required)
  208. - `metricTypes`: Which metrics to fetch (array of strings, required). Accepted values:
  209. - `cpu_usage`: CPU usage metrics (available for all resources)
  210. - `cpu_limit`: CPU resource constraints (available for all resources)
  211. - `cpu_target`: CPU autoscaling thresholds (available for all resources)
  212. - `memory_usage`: Memory usage metrics (available for all resources)
  213. - `memory_limit`: Memory resource constraints (available for all resources)
  214. - `memory_target`: Memory autoscaling thresholds (available for all resources)
  215. - `instance_count`: Instance count metrics (available for all resources)
  216. - `http_request_count`: HTTP request count metrics (services only)
  217. - `http_latency`: HTTP response time metrics (services only)
  218. - `bandwidth_usage`: Bandwidth usage metrics (services only)
  219. - `active_connections`: Active connection metrics (databases and key-value stores only)
  220. - `startTime`: Start time for metrics query in RFC3339 format (e.g., '2024-01-01T12:00:00Z'), defaults to 1 hour ago. The start time must be within the last 30 days (string, optional)
  221. - `endTime`: End time for metrics query in RFC3339 format (e.g., '2024-01-01T13:00:00Z'), defaults to the current time. The end time must be within the last 30 days (string, optional)
  222. - `resolution`: Time resolution for data points in seconds. Lower values provide more granular data. Higher values provide more aggregated data points. API defaults to 60 seconds if not provided, minimum 30 seconds (number, optional)
  223. - `cpuUsageAggregationMethod`: Method for aggregating CPU usage metric values over time intervals (string, optional). Defaults to `AVG`. Accepted values:
  224. - `AVG`: Average CPU usage over time intervals
  225. - `MAX`: Maximum CPU usage over time intervals
  226. - `MIN`: Minimum CPU usage over time intervals
  227. - `aggregateHttpRequestCountsBy`: Field to aggregate HTTP request count metrics by (string, optional). When not specified, returns total request counts. Accepted values:
  228. - `host`: Aggregate by request host
  229. - `statusCode`: Aggregate by HTTP status code
  230. - `httpLatencyQuantile`: The quantile/percentile of HTTP latency to fetch. Only supported for http_latency metric. Common values: 0.5 (median), 0.95 (95th percentile), 0.99 (99th percentile). Defaults to 0.95 if not specified (number, optional, min: 0.0, max: 1.0)
  231. - `httpHost`: Filter HTTP metrics to specific request hosts. Supported for http_request_count and http_latency metrics. Example: 'api.example.com' or 'myapp.render.com'. When not specified, includes all hosts (string, optional)
  232. - `httpPath`: Filter HTTP metrics to specific request paths. Supported for http_request_count and http_latency metrics. Example: '/api/users' or '/health'. When not specified, includes all paths (string, optional)
  233. ### Postgres Databases
  234. - **query_render_postgres** - Run a read-only SQL query against a Render-hosted Postgres database
  235. - `postgresId`: The ID of the Postgres instance to query (string, required)
  236. - `sql`: The SQL query to run (string, required)
  237. The tool connects over the database's external URL, so the database's IP allowlist applies. If the allowlist is empty, the tool reports that external connections are blocked instead of trying to connect. The hosted MCP server doesn't have IP addresses you can allowlist yet; to query an IP-restricted database, run the MCP server locally and add your IP address to the allowlist.
  238. - **list_postgres_instances** - List all PostgreSQL databases in your Render account
  239. - No parameters required
  240. - **get_postgres** - Get details about a specific PostgreSQL database
  241. - `postgresId`: The ID of the PostgreSQL database to retrieve (string, required)
  242. - **create_postgres** - Create a new PostgreSQL database
  243. - `name`: Name of the PostgreSQL database (string, required)
  244. - `plan`: Pricing plan for the database (string, required). Accepted values:
  245. - `free`
  246. - `basic_256mb`
  247. - `basic_1gb`
  248. - `basic_4gb`
  249. - `pro_4gb`
  250. - `pro_8gb`
  251. - `pro_16gb`
  252. - `pro_32gb`
  253. - `pro_64gb`
  254. - `pro_128gb`
  255. - `pro_192gb`
  256. - `pro_256gb`
  257. - `pro_384gb`
  258. - `pro_512gb`
  259. - `accelerated_16gb`
  260. - `accelerated_32gb`
  261. - `accelerated_64gb`
  262. - `accelerated_128gb`
  263. - `accelerated_256gb`
  264. - `accelerated_384gb`
  265. - `accelerated_512gb`
  266. - `accelerated_768gb`
  267. - `accelerated_1024gb`
  268. - `region`: Region for deployment (string, optional). Accepted values:
  269. - `oregon`
  270. - `frankfurt`
  271. - `singapore`
  272. - `ohio`
  273. - `virginia`
  274. - `version`: PostgreSQL version to use (e.g., 14, 15) (number, optional)
  275. - `diskSizeGb`: Database capacity in GB (number, optional)
  276. ### Key Value instances
  277. - **list_key_value** - List all Key Value instances in your Render account
  278. - No parameters required
  279. - **get_key_value** - Get details about a specific Key Value instance
  280. - `keyValueId`: The ID of the Key Value instance to retrieve (string, required)
  281. - **create_key_value** - Create a new Key Value instance
  282. - `name`: Name of the Key Value instance (string, required)
  283. - `plan`: Pricing plan for the Key Value instance (string, required). Accepted values:
  284. - `free`
  285. - `starter`
  286. - `standard`
  287. - `pro`
  288. - `pro_plus`
  289. - `region`: Region for deployment (string, optional). Accepted values:
  290. - `oregon`
  291. - `frankfurt`
  292. - `singapore`
  293. - `ohio`
  294. - `virginia`
  295. - `maxmemoryPolicy`: Eviction policy for the Key Value store (string, optional). Accepted values:
  296. - `noeviction`: No eviction policy (may cause memory errors)
  297. - `allkeys_lfu`: Evict least frequently used keys from all keys
  298. - `allkeys_lru`: Evict least recently used keys from all keys
  299. - `allkeys_random`: Evict random keys from all keys
  300. - `volatile_lfu`: Evict least frequently used keys from keys with expiration
  301. - `volatile_lru`: Evict least recently used keys from keys with expiration
  302. - `volatile_random`: Evict random keys from keys with expiration
  303. - `volatile_ttl`: Evict keys with shortest time to live from keys with expiration
  304. - `persistenceMode`: Data persistence behavior for the Key Value store (string, optional). Accepted values:
  305. - `journal_snapshot`: Append all writes to a journal and periodically save a snapshot to disk
  306. - `snapshot`: Periodically save a snapshot to disk
  307. - `off`: Disable persistence completely to prioritize write performance
  308. ### Blueprints
  309. The Blueprint tools are in public alpha (early access). Their availability and contracts are subject to change.
  310. All Blueprint tools require a workspace, supplied through `workspaceId` or the selected workspace. Calls using a Blueprint ID verify that it belongs to that workspace before returning details or making changes, including before its first sync is approved.
  311. - **create_blueprint** - Create a Blueprint from a remote repository and plan its first sync
  312. - `repoUrl`: Public repository URL or a repository accessible through a connected Git provider (string, required). Accepts `https://` or `ssh://` URLs without query strings or fragments. SSH URLs are converted to HTTPS; SCP-style remotes such as `git@host:path` are not accepted.
  313. - `branch`: Branch containing the Blueprint file (string, optional). Defaults to the repository's default branch.
  314. - `path`: Blueprint file path relative to the repository root (string, optional). Defaults to `render.yaml`.
  315. - `name`: Blueprint name (string, optional). Defaults to the repository name without the `.git` suffix.
  316. - `autoSync`: Whether later Git pushes automatically apply changes after the first sync is approved (boolean, optional). Defaults to `true`.
  317. - `existingResources`: How planning handles existing resources (string, optional). Accepted values: `create_new` (default), which creates separate resources with a Blueprint-specific suffix, and `adopt`, which brings matching resources under the Blueprint's management. Infrastructure changes require approval.
  318. - `workspaceId`: Workspace in which to create the Blueprint (string, optional). Falls back to the selected workspace when omitted; one of these must be available.
  319. - **get_blueprint** - Retrieve Blueprint settings, status, and managed resource IDs
  320. - `blueprintId`: Blueprint ID starting with `exs-` (string, required)
  321. - `workspaceId`: Workspace owning the Blueprint (string, optional). Falls back to the selected workspace when omitted.
  322. The Blueprint's `status` describes syncing, not service health. `created` means its first sync has not been approved. After approval, `paused` means auto-sync is disabled; manual planning and approval remain available.
  323. - **plan_blueprint** - Plan infrastructure changes using the Blueprint's configured Git branch and file path
  324. - `blueprintId`: Blueprint ID starting with `exs-` (string, required)
  325. - `workspaceId`: Workspace owning the Blueprint (string, optional). Falls back to the selected workspace when omitted.
  326. - **approve_blueprint** - Approve and apply the Blueprint's newest successfully planned sync after user review
  327. - `blueprintId`: Blueprint ID starting with `exs-`, not a sync ID (string, required)
  328. - `workspaceId`: Workspace owning the Blueprint (string, optional). Falls back to the selected workspace when omitted.
  329. - `manualEnvVars`: Values for every entry in `sync.requiredManualEnvVars` (array of objects, optional when no values are required). Each object requires these fields:
  330. - `serviceType`: Resource type from the required entry (string). Accepted values: `buildSource`, `cron`, `pserv`, `web`, `worker`, `workflow`.
  331. - `serviceName`: Resource name from the required entry (string)
  332. - `key`: Environment variable key from the required entry (string)
  333. - `value`: Exact user-provided value (string). Empty strings are allowed. Values appear as plaintext in the agent context.
  334. Apply only after the user authorizes the reviewed plan. Providing or allowing generation of manual values, or accepting costs, does not itself authorize deployment. The tool returns the sync state and `dashboardUrl` before the sync and deployments finish.
  335. - **update_blueprint** - Update Blueprint settings and plan changes when the branch or file path changes
  336. - `blueprintId`: Blueprint ID starting with `exs-` (string, required)
  337. - `workspaceId`: Workspace owning the Blueprint (string, optional). Falls back to the selected workspace when omitted.
  338. - `name`: New Blueprint name (string, optional)
  339. - `branch`: New Git branch (string, optional)
  340. - `path`: New Blueprint file path relative to the repository root (string, optional)
  341. - `autoSync`: Whether later Git pushes automatically apply changes after first-sync approval (boolean, optional)
  342. Supply at least one setting. Omitted settings keep their current values. Settings take effect immediately.
  343. Planning reads the remote repository, so push Blueprint file changes first. Review successfully planned
  344. changes before approval, including when auto-sync is enabled. Failed plans and plans with no changes must
  345. not be approved.
  346. ### Workflows
  347. Workflows tools let you create and deploy workflows, start flows, and inspect runs, results, steps, and logs.
  348. - **list_workflows** - List workflows in the workspace
  349. - `name`: Filter by workflow name (string, optional)
  350. - `environmentId`: Filter by environment ID (string, optional)
  351. - `limit`: Maximum workflows in this page (number, optional, 1 to 100; default `20`)
  352. - `cursor`: Cursor from the preceding page (string, optional)
  353. - `workspaceId`: Workspace to use (string, optional)
  354. - **get_workflow** - Get a workflow's configuration
  355. - `workflowId`: Workflow ID (string, required)
  356. - `workspaceId`: Workspace to use (string, optional)
  357. - **list_workflow_versions** - List versions and their build and registration status
  358. - `workflowId`: Filter by workflow ID (string, optional)
  359. - `limit`: Maximum versions in this page (number, optional, 1 to 100; default `20`)
  360. - `cursor`: Cursor from the preceding page (string, optional)
  361. - `workspaceId`: Workspace to use (string, optional)
  362. - **get_workflow_version** - Get a version's build and registration status
  363. - `workflowVersionId`: Workflow version ID (string, required)
  364. - `workspaceId`: Workspace to use (string, optional)
  365. - **list_workflow_tasks** - List tasks registered by workflow versions
  366. - `workflowId`: Filter by workflow ID (string, optional)
  367. - `workflowVersionId`: Filter by workflow version ID (string, optional)
  368. - `taskSlug`: Filter by workflow-slug/task-name, optionally with `:version` (string, optional)
  369. - `limit`: Maximum tasks in this page (number, optional, 1 to 100; default `20`)
  370. - `cursor`: Cursor from the preceding page (string, optional)
  371. - `workspaceId`: Workspace to use (string, optional)
  372. - **get_workflow_task** - Get a registered task
  373. - `taskId`: Task ID (string, required)
  374. - `workspaceId`: Workspace to use (string, optional)
  375. - **list_workflow_runs** - List task runs with status, attempts, and parent/root relationships
  376. - `workflowId`: Filter by workflow ID (string, optional)
  377. - `workflowVersionId`: Filter by workflow version ID (string, optional)
  378. - `taskSlug`: Filter by workflow-slug/task-name, optionally with `:version` (string, optional)
  379. - `rootTaskRunId`: Filter to a run tree by its root task run ID (string, optional)
  380. - `limit`: Maximum runs in this page (number, optional, 1 to 100; default `20`)
  381. - `cursor`: Cursor from the preceding page (string, optional)
  382. - `workspaceId`: Workspace to use (string, optional)
  383. - **get_workflow_run** - Get a task run's status, errors, and attempts
  384. - `taskRunId`: Task run ID (string, required)
  385. - `workspaceId`: Workspace to use (string, optional)
  386. Inputs and results are omitted. Use `get_workflow_run_results` to read results.
  387. - **get_workflow_run_results** - Read a terminal task run's or attempt's results as paged JSON text
  388. - `taskRunId`: Task run ID (string, required)
  389. - `attempt`: Zero-indexed attempt number; omit for the run's results (number, optional, integer at least 0)
  390. - `offset`: UTF-8 byte offset from the preceding page's `nextOffset` (number, optional, integer at least 0; default `0`)
  391. - `limit`: Maximum result bytes in this page (number, optional, 4 to 32768; default `32768`)
  392. - `sha256`: Hash from the first page; required when `offset` is greater than zero (string, optional)
  393. - `workspaceId`: Workspace to use (string, optional)
  394. A nonterminal run or attempt returns `ready: false`. Concatenate `content` until `nextOffset` is null, and check the
  395. returned status rather than treating `ready: true` as success.
  396. - **create_workflow** - Create a workflow from a Git repository
  397. - `name`: Workflow name (string, required)
  398. - `repo`: Git repository URL Render can clone, without credentials (string, required)
  399. - `runtime`: Workflow runtime (string, required). Accepted values: `node`, `python`, `go`, `ruby`, `elixir`.
  400. - `buildCommand`: Dependency installation and build command (string, required)
  401. - `runCommand`: Command that registers the workflow's tasks (string, required)
  402. - `branch`: Repository branch; omit for the default branch (string, optional)
  403. - `rootDir`: Repository subdirectory; omit for the repository root (string, optional)
  404. - `region`: Workflow region (string, optional; default `oregon`). Accepted values: `oregon`, `frankfurt`, `singapore`, `ohio`, `virginia`.
  405. - `autoDeploy`: Deployment trigger (string, optional; default `commit`). Accepted values: `commit`, `checksPass`, `off`.
  406. - `envVars`: Environment variables for builds and task execution (array of objects, optional). Each object requires string `key` and `value`; empty values are allowed.
  407. - `workspaceId`: Workspace to use (string, optional)
  408. The Render SDK currently supports defining tasks and flows in TypeScript (`node`) and Python (`python`).
  409. Workflows also supports Docker, but `create_workflow` does not currently support creating Docker-based workflows.
  410. Creation starts an initial build unless `autoDeploy` is `off`. It does not start a task run. If creation times
  411. out, use `list_workflows` to check whether the workflow exists before retrying.
  412. - **create_workflow_version** - Request deployment of a new version of an existing workflow
  413. - `workflowId`: Workflow ID (string, required)
  414. - `commit`: Git commit to deploy; omit for the linked branch's current commit (string, optional)
  415. - `workspaceId`: Workspace to use (string, optional)
  416. Skip this after creation or a push when automatic deployment is expected. Acceptance does not mean readiness;
  417. use `get_workflow_version` or `list_workflow_versions` to check progress.
  418. - **list_flows** - List flows registered by workflow versions
  419. - `workflowVersionId`: Filter by workflow version ID (string, optional)
  420. - `flowSlug`: Filter by workflow-slug/flow-name, optionally with `:version` (string, optional)
  421. - `limit`: Maximum flows in this page (number, optional, 1 to 100; default `20`)
  422. - `cursor`: Cursor from the preceding page (string, optional)
  423. - `workspaceId`: Workspace to use (string, optional)
  424. To run a specific version, filter by `workflowVersionId`, then pass the returned flow ID to `start_flow_run`.
  425. - **get_flow** - Get a registered flow and its workflow version
  426. - `flowId`: Flow ID (string, required)
  427. - `workspaceId`: Workspace to use (string, optional)
  428. - **list_flow_runs** - List flow runs with status and timestamps
  429. - `workflowId`: Filter by workflow ID (string, optional)
  430. - `workflowVersionId`: Filter by workflow version ID (string, optional)
  431. - `flowId`: Filter by flow ID (string, optional)
  432. - `flowSlug`: Filter by workflow-slug/flow-name, optionally with `:version` (string, optional)
  433. - `status`: Filter by status (string, optional). Accepted values: `pending`, `running`, `succeeded`, `failed`, `canceled`.
  434. - `limit`: Maximum runs in this page (number, optional, 1 to 100; default `20`)
  435. - `cursor`: Cursor from the preceding page (string, optional)
  436. - `workspaceId`: Workspace to use (string, optional)
  437. - **get_flow_run** - Get a flow run's status, errors, error details, and attempts
  438. - `flowRunId`: Flow run ID (string, required)
  439. - `workspaceId`: Workspace to use (string, optional)
  440. Inputs and results are omitted. Use `get_flow_run_results` for results, `list_flow_run_steps` for steps, and
  441. `list_logs` with the workflow ID as `resource` and this run ID as `taskRun` for logs.
  442. - **get_flow_run_results** - Read a terminal flow run's results as paged JSON text
  443. - `flowRunId`: Flow run ID (string, required)
  444. - `offset`: UTF-8 byte offset from the preceding page's `nextOffset` (number, optional, integer at least 0; default `0`)
  445. - `limit`: Maximum result bytes in this page (number, optional, 4 to 32768; default `32768`)
  446. - `sha256`: Hash from the first page; required when `offset` is greater than zero (string, optional)
  447. - `workspaceId`: Workspace to use (string, optional)
  448. A nonterminal run returns `ready: false`. Concatenate `content` until `nextOffset` is null, and check status.
  449. - **list_flow_run_steps** - List a flow run's steps in the order they started
  450. - `flowRunId`: Flow run ID (string, required)
  451. - `limit`: Maximum steps in this page (number, optional, 1 to 100; default `20`)
  452. - `cursor`: Cursor from the preceding page (string, optional)
  453. - `workspaceId`: Workspace to use (string, optional)
  454. - **get_flow_run_step** - Get a step's status, result, and error; its input is omitted
  455. - `flowRunId`: Flow run ID (string, required)
  456. - `seq`: Sequence number from `list_flow_run_steps` (number, required, integer at least 0)
  457. - `stepKey`: Key from `list_flow_run_steps` when steps share a sequence number (string, optional)
  458. - `workspaceId`: Workspace to use (string, optional)
  459. - **start_flow_run** - Start a run of a registered flow
  460. - `flow`: Exact flow ID (`flw-...`), not a slug (string, required)
  461. - `input`: Positional arguments as an array or named arguments as an object (array or object, optional)
  462. - `idempotencyKey`: Fresh UUID for this run; reuse the same key after a timeout or disconnect (string, optional)
  463. - `workspaceId`: Workspace to use (string, optional)
  464. Wait for the selected workflow version to become ready before starting a run. Poll `get_flow_run`, then read
  465. results, steps, and logs. A repeated idempotency key within 24 hours returns the first run.
  466. - **cancel_flow_run** - Request cancellation of a pending or running flow run
  467. - `flowRunId`: Flow run ID (string, required)
  468. - `workspaceId`: Workspace to use (string, optional)
  469. Cancellation cannot be undone.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.