render-deploy skill (openai/skills)
- Install
- SKILL.md (verbatim)
- Prerequisites
- When to Use This Skill
- Happy Path (New Users)
- Choose Your Source Path
- Choose Your Deployment Method (Git Repo)
- Method Selection Heuristic
- Prerequisites Check
- Cursor
- Claude Code
- Codex
- Other Tools
- Workspace Selection
- Blueprint Workflow
- Step 1: Analyze Codebase
- Step 2: Generate render.yaml
- Step 2.5: Immediate Next Steps (Always Provide)
- Step 3: Validate Configuration
- Step 4: Commit and Push
- Step 5: Generate Deeplink
- Step 6: Guide User
- Step 7: Verify Deployment
- When to Use Direct Creation
- Prerequisites for Direct Creation
- Direct Creation Workflow
- Step 1: Analyze Codebase
- Step 2: Create Resources via MCP
- Step 3: Configure Environment Variables
- Step 4: Verify Deployment
- Troubleshooting
- Escalated Network Access
- Other files in this skill
- references/blueprint-spec.md (verbatim)
- Overview
- Root-Level Structure
- Service Types
- Web Services (type: web)
- Worker Services (type: worker)
- Cron Jobs (type: cron)
- Static Sites (type: static or type: web with runtime: static)
- Private Services (type: pserv)
- Runtimes
- Native Runtimes
- Docker Runtime
- Service Plans
- Regions
- Environment Variables
- 1. Hardcoded Values
- 2. Generated Secrets
- 3. User-Provided Secrets
- 4. Database References
- 5. Service References
- 6. Environment Variable Groups
- Databases
- PostgreSQL
- Redis (Key-Value Store)
- Scaling
- Manual Scaling
- Autoscaling
- Health Checks
- Build Filters
- Projects and Environments
- Preview Environments
- Complete Example
- Validation
- Best Practices
- Additional Resources
- references/codebase-analysis.md (verbatim)
- Node.js Projects
- Python Projects
- Go Projects
- Static Sites
- Docker Projects
- Key Information to Extract
- references/configuration-guide.md (verbatim)
- Environment Variables
- Required vs Optional Variables
- Database Connection Patterns
- Cross-Service References
- Environment Variable Groups
- Port Binding
- The Port Binding Requirement
- Code Examples by Language
- Build Commands
- Non-Interactive Flags
- Build with Additional Steps
- Build Timeouts
- Database Connections
- Internal vs External URLs
- Connection Pooling
- Database Migrations
- Free Tier Limitations
- What's Included
- Resource Limits
- When to Upgrade
- Health Checks
- Adding Health Check Endpoints
- Configure in render.yaml
- Common Deployment Issues
- Issue 1: Missing Environment Variables
- Issue 2: Port Binding Errors
- Issue 3: Build Hangs
- Issue 4: Database Connection Fails
- Issue 5: Static Site 404s
- Issue 6: Out of Memory (OOM)
- Best Practices Checklist
- Additional Resources
- references/deployment-details.md (verbatim)
- Service Discovery
- Configuration Details
- Environment Variables
- Port Binding
- Plan Defaults
- Build Commands
- Database Connections
- Health Checks
- Quick Reference
- MCP Tools (Preferred)
- CLI Commands
- Templates by Framework
- Documentation
- Common Issues
- references/direct-creation.md (verbatim)
- Direct Creation Workflow
- Step 1: Analyze Codebase
- Step 2: Create Resources via MCP
- Step 3: Configure Environment Variables
- Step 4: Verify Deployment
What it does. Deploy applications to Render by analyzing codebases, generating render.yaml Blueprints, and providing Dashboard deeplinks. Use when the user wants to deploy, host, publish, or set up their application on Render's cloud platform. Part of openai/skills (Skills Catalog for Codex) (openai/skills).
| Upstream | openai/skills |
| Skill file | skills/.curated/render-deploy/SKILL.md |
| License | Apache-2.0 (skill folder LICENSE.txt) |
| Author | OpenAI |
| Fetched | 2026-09-10 |
Install
- Codex:
$skill-installerinstalls from this catalog ($render-deployinvokes it); other agents:npx skills add openai/skills --skill render-deploy. - Raw file:
curl -sL https://raw.githubusercontent.com/openai/skills/HEAD/skills/.curated/render-deploy/SKILL.md
SKILL.md (verbatim)
2 placeholder credentials were shortened (for example to
api_key=YOUR_KEY) to pass the site's secret filter.
name: render-deploy
description: Deploy applications to Render by analyzing codebases, generating render.yaml Blueprints, and providing Dashboard deeplinks. Use when the user wants to deploy, host, publish, or set up their application on Render's cloud platform.
Deploy to Render
Render supports Git-backed services and prebuilt Docker image services.
This skill covers Git-backed flows:
- Blueprint Method - Generate render.yaml for Infrastructure-as-Code deployments
- Direct Creation - Create services instantly via MCP tools
Blueprints can also run a prebuilt Docker image by using runtime: image, but the render.yaml still must live in a Git repo.
If there is no Git remote, stop and ask the user to either:
- Create/push a Git remote (can be minimal if only the Blueprint is needed), or
- Use the Render Dashboard/API to deploy a prebuilt Docker image (MCP cannot create image-backed services).
Prerequisites
- When sandboxing blocks the deployment network calls, rerun with
sandbox_permissions=require_escalated. - The deployment might take a few minutes. Use appropriate timeout values.
When to Use This Skill
Activate this skill when users want to:
- Deploy an application to Render
- Create a render.yaml Blueprint file
- Set up Render deployment for their project
- Host or publish their application on Render's cloud platform
- Create databases, cron jobs, or other Render resources
Happy Path (New Users)
Use this short prompt sequence before deep analysis to reduce friction:
- Ask whether they want to deploy from a Git repo or a prebuilt Docker image.
- Ask whether Render should provision everything the app needs (based on what seems likely from the user's description) or only the app while they bring their own infra. If dependencies are unclear, ask a short follow-up to confirm whether they need a database, workers, cron, or other services.
Then proceed with the appropriate method below.
Choose Your Source Path
Git Repo Path: Required for both Blueprint and Direct Creation. The repo must be pushed to GitHub, GitLab, or Bitbucket.
Prebuilt Docker Image Path: Supported by Render via image-backed services. This is not supported by MCP; use the Dashboard/API. Ask for:
- Image URL (registry + tag)
- Registry auth (if private)
- Service type (web/worker) and port
If the user chooses a Docker image, guide them to the Render Dashboard image deploy flow or ask them to add a Git remote (so you can use a Blueprint with runtime: image).
Choose Your Deployment Method (Git Repo)
Both methods require a Git repository pushed to GitHub, GitLab, or Bitbucket. (If using runtime: image, the repo can be minimal and only contain render.yaml.)
| Method | Best For | Pros |
|---|---|---|
| Blueprint | Multi-service apps, IaC workflows | Version controlled, reproducible, supports complex setups |
| Direct Creation | Single services, quick deployments | Instant creation, no render.yaml file needed |
Method Selection Heuristic
Use this decision rule by default unless the user requests a specific method. Analyze the codebase first; only ask if deployment intent is unclear (e.g., DB, workers, cron).
Use Direct Creation (MCP) when ALL are true:
- Single service (one web app or one static site)
- No separate worker/cron services
- No attached databases or Key Value
- Simple env vars only (no shared env groups) If this path fits and MCP isn't configured yet, stop and guide MCP setup before proceeding.
Use Blueprint when ANY are true:
- Multiple services (web + worker, API + frontend, etc.)
- Databases, Redis/Key Value, or other datastores are required
- Cron jobs, background workers, or private services
- You want reproducible IaC or a render.yaml committed to the repo
- Monorepo or multi-env setup that needs consistent configuration
If unsure, ask a quick clarifying question, but default to Blueprint for safety. For a single service, strongly prefer Direct Creation via MCP and guide MCP setup if needed.
Prerequisites Check
When starting a deployment, verify these requirements in order:
1. Confirm Source Path (Git vs Docker)
If using Git-based methods (Blueprint or Direct Creation), the repo must be pushed to GitHub/GitLab/Bitbucket. Blueprints that reference a prebuilt image still require a Git repo with render.yaml.
git remote -v
- If no remote exists, stop and ask the user to create/push a remote or switch to Docker image deploy.
2. Check MCP Tools Availability (Preferred for Single-Service)
MCP tools provide the best experience. Check if available by attempting:
list_services()
If MCP tools are available, you can skip CLI installation for most operations.
3. Check Render CLI Installation (for Blueprint validation)
render --version
If not installed, offer to install:
- macOS:
brew install render - Linux/macOS:
curl -fsSL https://raw.githubusercontent.com/render-oss/cli/main/bin/install.sh | sh
4. MCP Setup (if MCP isn't configured)
If list_services() fails because MCP isn't configured, ask whether they want to set up MCP (preferred) or continue with the CLI fallback. If they choose MCP, ask which AI tool they're using, then provide the matching instructions below. Always use their API key.
Cursor
Walk the user through these steps:
- Get a Render API key:
https://dashboard.render.com/u/*/settings#api-keys
- Add this to
~/.cursor/mcp.json(replace<YOUR_API_KEY>):
{
"mcpServers": {
"render": {
"url": "https://mcp.render.com/mcp",
"headers": {
"Authorization": "Bearer <YOUR_API_KEY>"
}
}
}
}
- Restart Cursor, then retry
list_services().
Claude Code
Walk the user through these steps:
- Get a Render API key:
https://dashboard.render.com/u/*/settings#api-keys
- Add the MCP server with Claude Code (replace
<YOUR_API_KEY>):
claude mcp add --transport http render https://mcp.render.com/mcp --header "Authorization: Bearer <YOUR_API_KEY>"
- Restart Claude Code, then retry
list_services().
Codex
Walk the user through these steps:
- Get a Render API key:
https://dashboard.render.com/u/*/settings#api-keys
- Set it in their shell:
export RENDER_API_KEY=YOUR_KEY
- Add the MCP server with the Codex CLI:
codex mcp add render --url https://mcp.render.com/mcp --bearer-token-env-var RENDER_API_KEY
- Restart Codex, then retry
list_services().
Other Tools
If the user is on another AI app, direct them to the Render MCP docs for that tool's setup steps and install method.
Workspace Selection
After MCP is configured, have the user set the active Render workspace with a prompt like:
Set my Render workspace to [WORKSPACE_NAME]
5. Check Authentication (CLI fallback only)
If MCP isn't available, use the CLI instead and verify you can access your account:
# Check if user is logged in (use -o json for non-interactive mode)
render whoami -o json
If render whoami fails or returns empty data, the CLI is not authenticated. The CLI won't always prompt automatically, so explicitly prompt the user to authenticate:
If neither is configured, ask user which method they prefer:
- API Key (CLI): `export RENDER_API_KEY=YOUR_KEY (Get from https://dashboard.render.com/u/*/settings#api-keys)
- Login:
render login(Opens browser for OAuth)
6. Check Workspace Context
Verify the active workspace:
get_selected_workspace()
Or via CLI:
render workspace current -o json
To list available workspaces:
list_workspaces()
If user needs to switch workspaces, they must do so via Dashboard or CLI (render workspace set).
Once prerequisites are met, proceed with deployment workflow.
Method 1: Blueprint Deployment (Recommended for Complex Apps)
Blueprint Workflow
Step 1: Analyze Codebase
Analyze the codebase to determine framework/runtime, build and start commands, required env vars, datastores, and port binding. Use the detailed checklists in references/codebase-analysis.md.
Step 2: Generate render.yaml
Create a render.yaml Blueprint file following the Blueprint specification.
Complete specification: references/blueprint-spec.md
Key Points:
- Always use
plan: freeunless user specifies otherwise - Include ALL environment variables the app needs
- Mark secrets with
sync: false(user fills these in Dashboard) - Use appropriate service type:
web,worker,cron,static, orpserv - Use appropriate runtime: references/runtimes.md
Basic Structure:
services:
- type: web
name: my-app
runtime: node
plan: free
buildCommand: npm ci
startCommand: npm start
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
- key: JWT_SECRET
sync: false # User fills in Dashboard
databases:
- name: postgres
databaseName: myapp_db
plan: free
Service Types:
web: HTTP services, APIs, web applications (publicly accessible)worker: Background job processors (not publicly accessible)cron: Scheduled tasks that run on a cron schedulestatic: Static sites (HTML/CSS/JS served via CDN)pserv: Private services (internal only, within same account)
Service type details: references/service-types.md Runtime options: references/runtimes.md Template examples: assets/
Step 2.5: Immediate Next Steps (Always Provide)
After creating render.yaml, always give the user a short, explicit checklist and run validation immediately when the CLI is available:
- Authenticate (CLI): run
render whoami -o json(if not logged in, runrender loginor setRENDER_API_KEY) - Validate (recommended): run
render blueprints validate- If the CLI isn't installed, offer to install it and provide the command.
- Commit + push:
git add render.yaml && git commit -m "Add Render deployment configuration" && git push origin main - Open Dashboard: Use the Blueprint deeplink and complete Git OAuth if prompted
- Fill secrets: Set env vars marked
sync: false - Deploy: Click "Apply" and monitor the deploy
Step 3: Validate Configuration
Validate the render.yaml file to catch errors before deployment. If the CLI is installed, run the commands directly; only prompt the user if the CLI is missing:
render whoami -o json # Ensure CLI is authenticated (won't always prompt)
render blueprints validate
Fix any validation errors before proceeding. Common issues:
- Missing required fields (
name,type,runtime) - Invalid runtime values
- Incorrect YAML syntax
- Invalid environment variable references
Configuration guide: references/configuration-guide.md
Step 4: Commit and Push
IMPORTANT: You must merge the render.yaml file into your repository before deploying.
Ensure the render.yaml file is committed and pushed to your Git remote:
git add render.yaml
git commit -m "Add Render deployment configuration"
git push origin main
If there is no Git remote yet, stop here and guide the user to create a GitHub/GitLab/Bitbucket repo, add it as origin, and push before continuing.
Why this matters: The Dashboard deeplink will read the render.yaml from your repository. If the file isn't merged and pushed, Render won't find the configuration and deployment will fail.
Verify the file is in your remote repository before proceeding to the next step.
Step 5: Generate Deeplink
Get the Git repository URL:
git remote get-url origin
This will return a URL from your Git provider. If the URL is SSH format, convert it to HTTPS:
| SSH Format | HTTPS Format |
|---|---|
git@github.com:user/repo.git |
https://github.com/user/repo |
git@gitlab.com:user/repo.git |
https://gitlab.com/user/repo |
git@bitbucket.org:user/repo.git |
https://bitbucket.org/user/repo |
Conversion pattern: Replace git@<host>: with https://<host>/ and remove .git suffix.
Format the Dashboard deeplink using the HTTPS repository URL:
https://dashboard.render.com/blueprint/new?repo=<REPOSITORY_URL>
Example:
https://dashboard.render.com/blueprint/new?repo=https://github.com/username/repo-name
Step 6: Guide User
CRITICAL: Ensure the user has merged and pushed the render.yaml file to their repository before clicking the deeplink. If the file isn't in the repository, Render cannot read the Blueprint configuration and deployment will fail.
Provide the deeplink to the user with these instructions:
- Verify render.yaml is merged - Confirm the file exists in your repository on GitHub/GitLab/Bitbucket
- Click the deeplink to open Render Dashboard
- Complete Git provider OAuth if prompted
- Name the Blueprint (or use default from render.yaml)
- Fill in secret environment variables (marked with
sync: false) - Review services and databases configuration
- Click "Apply" to deploy
The deployment will begin automatically. Users can monitor progress in the Render Dashboard.
Step 7: Verify Deployment
After the user deploys via Dashboard, verify everything is working.
Check deployment status via MCP:
list_deploys(serviceId: "<service-id>", limit: 1)
Look for status: "live" to confirm successful deployment.
Check for runtime errors (wait 2-3 minutes after deploy):
list_logs(resource: ["<service-id>"], level: ["error"], limit: 20)
Check service health metrics:
get_metrics(
resourceId: "<service-id>",
metricTypes: ["http_request_count", "cpu_usage", "memory_usage"]
)
If errors are found, proceed to the Post-deploy verification and basic triage section below.
Method 2: Direct Service Creation (Quick Single-Service Deployments)
For simple deployments without Infrastructure-as-Code, create services directly via MCP tools.
When to Use Direct Creation
- Single web service or static site
- Quick prototypes or demos
- When you don't need a render.yaml file in your repo
- Adding databases or cron jobs to existing projects
Prerequisites for Direct Creation
Repository must be pushed to a Git provider. Render clones your repository to build and deploy services.
git remote -v # Verify remote exists
git push origin main # Ensure code is pushed
Supported providers: GitHub, GitLab, Bitbucket
If no remote exists, stop and ask the user to create/push a remote or switch to Docker image deploy.
Note: MCP does not support creating image-backed services. Use the Dashboard/API for prebuilt Docker image deploys.
Direct Creation Workflow
Use the concise steps below, and refer to references/direct-creation.md for full MCP command examples and follow-on configuration.
Step 1: Analyze Codebase
Use references/codebase-analysis.md to determine runtime, build/start commands, env vars, and datastores.
Step 2: Create Resources via MCP
Create the service (web or static) and any required databases or key-value stores. See references/direct-creation.md.
If MCP returns an error about missing Git credentials or repo access, stop and guide the user to connect their Git provider in the Render Dashboard, then retry.
Step 3: Configure Environment Variables
Add required env vars via MCP after creation. See references/direct-creation.md.
Remind the user that secrets can be set in the Dashboard if they prefer not to pass them via MCP.
Step 4: Verify Deployment
Check deploy status, logs, and metrics. See references/direct-creation.md.
For service discovery, configuration details, quick commands, and common issues, see references/deployment-details.md.
Post-deploy verification and basic triage (All Methods)
Keep this short and repeatable. If any check fails, fix it before redeploying.
- Confirm the latest deploy is
liveand serving traffic - Hit the health endpoint (or root) and verify a 200 response
- Scan recent error logs for a clear failure signature
- Verify required env vars and port binding (
0.0.0.0:$PORT)
Detailed checklist and commands: references/post-deploy-checks.md
If the service fails to start or health checks time out, use the basic triage guide: references/troubleshooting-basics.md
Troubleshooting
Escalated Network Access
If deployment fails due to network issues (timeouts, DNS errors, connection resets), rerun the deploy with escalated permissions (use sandbox_permissions=require_escalated). The deploy requires escalated network access when sandbox networking blocks outbound requests.
Example guidance to the user:
The deploy needs escalated network access to deploy to Render. I can rerun the command with escalated permissions—want me to proceed?
Optional: If you need deeper diagnostics (metrics/DB checks/error catalog), suggest installing the
render-debug skill. It is not required for the core deploy flow.
Other files in this skill
- LICENSE.txt
- agents/openai.yaml
- assets/docker.yaml
- assets/go-api.yaml
- assets/nextjs-postgres.yaml
- assets/node-express.yaml
- assets/python-django.yaml
- assets/render-small.svg
- assets/render.png
- assets/static-site.yaml
- references/blueprint-spec.md
- references/codebase-analysis.md
- references/configuration-guide.md
- references/deployment-details.md
- references/direct-creation.md
- references/error-patterns.md
- references/post-deploy-checks.md
- references/runtimes.md
- references/service-types.md
- references/troubleshooting-basics.md
references/blueprint-spec.md (verbatim)
Render Blueprint Specification
Complete reference for render.yaml Blueprint files. Blueprints define your infrastructure as code for reproducible deployments on Render.
Overview
A Blueprint is a YAML file (typically render.yaml) placed in your repository root that describes:
- Services (web, worker, cron, static, private)
- Databases (PostgreSQL, Redis)
- Environment variables and secrets
- Scaling and resource configuration
- Project organization
Root-Level Structure
# Top-level fields
services: [] # Array of service definitions
databases: [] # Array of PostgreSQL databases
envVarGroups: [] # Reusable environment variable groups (optional)
projects: [] # Project organization (optional)
ungrouped: [] # Resources outside projects (optional)
previews: # Preview environment configuration (optional)
generation: auto_preview | manual | none
Service Types
Web Services (type: web)
HTTP services, APIs, and web applications. Publicly accessible via HTTPS.
Required fields:
name: Unique service identifiertype: Must bewebruntime: Language/environment (see Runtimes section)buildCommand: Command to build the applicationstartCommand: Command to start the server
Common optional fields:
plan: Instance type (default:free)region: Deployment region (default:oregon)branch: Git branch to deploy (default:main)autoDeploy: Auto-deploy on push (default:true)envVars: Environment variables arrayhealthCheckPath: Health check endpoint (default:/)numInstances: Number of instances (manual scaling)scaling: Autoscaling configuration
Example:
services:
- type: web
name: api-server
runtime: node
plan: free
buildCommand: npm ci
startCommand: npm start
branch: main
autoDeploy: true
envVars:
- key: NODE_ENV
value: production
- key: PORT
value: 10000
Worker Services (type: worker)
Background job processors, queue consumers. Not publicly accessible.
Required fields:
name: Unique service identifiertype: Must beworkerruntime: Language/environmentbuildCommand: Command to buildstartCommand: Command to start worker process
Key differences from web services:
- No public URL
- No health checks
- No port binding required
Example:
services:
- type: worker
name: job-processor
runtime: python
plan: free
buildCommand: pip install -r requirements.txt
startCommand: celery -A tasks worker --loglevel=info
envVars:
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
Cron Jobs (type: cron)
Scheduled tasks that run on a cron schedule.
Required fields:
name: Unique service identifiertype: Must becronruntime: Language/environmentschedule: Cron expressionbuildCommand: Command to buildstartCommand: Command to execute on schedule
Schedule format: Standard cron syntax (minute hour day month weekday)
Examples:
0 0 * * *- Daily at midnight UTC*/15 * * * *- Every 15 minutes0 9 * * 1- Every Monday at 9 AM UTC
Example:
services:
- type: cron
name: daily-backup
runtime: node
schedule: "0 2 * * *"
buildCommand: npm ci
startCommand: node scripts/backup.js
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
Static Sites (type: static or type: web with runtime: static)
Serve static HTML/CSS/JS files via CDN.
Required fields:
name: Unique service identifiertype:webruntime:staticbuildCommand: Command to build static assetsstaticPublishPath: Path to built files (e.g.,./build,./dist)
Optional configuration:
routes: Routing rules for SPAsheaders: Custom HTTP headersbuildFilter: Path filters for build triggers
Example:
services:
- type: web
name: react-app
runtime: static
buildCommand: npm ci && npm run build
staticPublishPath: ./dist
routes:
- type: rewrite
source: /*
destination: /index.html
headers:
- path: /*
name: Cache-Control
value: public, max-age=31536000, immutable
Private Services (type: pserv)
Internal services accessible only within your Render account.
Required fields:
name: Unique service identifiertype: Must bepservruntime: Language/environmentbuildCommand: Command to buildstartCommand: Command to start
Use cases:
- Internal APIs
- Database proxies
- Microservices not exposed to internet
Example:
services:
- type: pserv
name: internal-api
runtime: go
plan: free
buildCommand: go build -o bin/app
startCommand: ./bin/app
Runtimes
Native Runtimes
Node.js (runtime: node):
- Versions: 14, 16, 18, 20, 21
- Default version: 20
- Specify version in
package.jsonengines field
Python (runtime: python):
- Versions: 3.8, 3.9, 3.10, 3.11, 3.12
- Default version: 3.11
- Specify version in
runtime.txtorPipfile
Go (runtime: go):
- Versions: 1.20, 1.21, 1.22, 1.23
- Uses go modules
- Version from
go.mod
Ruby (runtime: ruby):
- Versions: 3.0, 3.1, 3.2, 3.3
- Uses Bundler
- Version from
.ruby-versionorGemfile
Rust (runtime: rust):
- Latest stable version
- Uses Cargo
Elixir (runtime: elixir):
- Latest stable version
- Uses Mix
Docker Runtime
Docker (runtime: docker):
Build from a Dockerfile in your repository.
Additional fields:
dockerfilePath: Path to Dockerfile (default:./Dockerfile)dockerContext: Build context directory (default:.)
Example:
services:
- type: web
name: docker-app
runtime: docker
dockerfilePath: ./docker/Dockerfile
dockerContext: .
plan: free
Image (runtime: image):
Deploy pre-built Docker images from a registry.
Additional fields:
image: Image URL (e.g.,registry.com/image:tag)registryCredential: Credentials for private registries
Example:
services:
- type: web
name: prebuilt-app
runtime: image
image: myregistry.com/app:v1.2.3
plan: free
Service Plans
Available instance types:
| Plan | RAM | CPU | Price |
|---|---|---|---|
free |
512 MB | 0.5 | Free (750 hrs/mo) |
starter |
512 MB | 0.5 | $7/month |
standard |
2 GB | 1 | $25/month |
pro |
4 GB | 2 | $85/month |
pro_plus |
8 GB | 4 | $175/month |
Always default to plan: free unless user specifies otherwise.
Regions
Available deployment regions:
oregon(US West) - Defaultohio(US East)virginia(US East)frankfurt(EU)singapore(Asia)
Example:
services:
- type: web
name: my-app
runtime: node
region: frankfurt
Environment Variables
Three patterns for defining environment variables:
1. Hardcoded Values
For non-sensitive configuration:
envVars:
- key: NODE_ENV
value: production
- key: API_URL
value: https://api.example.com
- key: LOG_LEVEL
value: info
2. Generated Secrets
Render generates a base64-encoded 256-bit random value:
envVars:
- key: SESSION_SECRET
generateValue: true
- key: ENCRYPTION_KEY
generateValue: true
3. User-Provided Secrets
Prompt user for values during Blueprint creation:
envVars:
- key: STRIPE_SECRET_KEY
sync: false
- key: JWT_SECRET
sync: false
- key: API_KEY
sync: false
The sync: false flag means "user will fill this in the Dashboard".
4. Database References
Link to database connection strings:
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
Available properties:
connectionString: Full connection URLhost: Database hostport: Database portuser: Database usernamepassword: Database passworddatabase: Database namehostport: Combinedhost:port
5. Service References
Link to other services:
envVars:
- key: API_URL
fromService:
name: api-server
type: web
property: host
6. Environment Variable Groups
Reusable groups shared across services:
envVarGroups:
- name: shared-config
envVars:
- key: LOG_LEVEL
value: info
- key: ENVIRONMENT
value: production
services:
- type: web
name: web-app
runtime: node
envVars:
- fromGroup: shared-config
- key: PORT
value: 10000
Databases
PostgreSQL
databases:
- name: postgres
databaseName: myapp_prod
user: myapp_user
plan: free
postgresMajorVersion: "15"
ipAllowList: []
Plans:
free: 1 GB storage, 97 MB RAM, 0.1 CPUbasic-256mb,basic-512mb,basic-1gb,basic-4gbpro-4gb,pro-8gb,pro-16gb, etc.accelerated-4gb,accelerated-8gb, etc. (SSD-backed)
Key fields:
name: Identifier for referencesdatabaseName: Actual PostgreSQL database nameuser: Database usernamepostgresMajorVersion: PostgreSQL version (11-16)ipAllowList: Array of CIDR blocks (empty = internal only)diskSizeGB: Storage size (paid plans only)
High Availability (paid plans):
databases:
- name: postgres
databaseName: myapp_prod
plan: pro-4gb
highAvailabilityEnabled: true
Read Replicas (paid plans):
databases:
- name: postgres
databaseName: myapp_prod
plan: pro-4gb
readReplicas:
- name: read-replica-1
region: ohio
- name: read-replica-2
region: frankfurt
Redis (Key-Value Store)
databases:
- name: redis
plan: free
maxmemoryPolicy: allkeys-lru
ipAllowList: []
Plans: Same as PostgreSQL
maxmemoryPolicy options:
allkeys-lru: Evict least recently used keysvolatile-lru: Evict LRU keys with TTLallkeys-random: Evict random keysvolatile-random: Evict random keys with TTLvolatile-ttl: Evict keys with soonest TTLnoeviction: Return errors when memory full
Scaling
Manual Scaling
Fixed number of instances:
services:
- type: web
name: my-app
runtime: node
plan: standard
numInstances: 3
Autoscaling
Dynamic scaling based on CPU/memory (Professional workspace required):
services:
- type: web
name: my-app
runtime: node
plan: standard
scaling:
minInstances: 1
maxInstances: 5
targetCPUPercent: 60
targetMemoryPercent: 70
Notes:
- Autoscaling disabled in preview environments
- Preview environments run
minInstancescount - Requires Professional or higher workspace
Health Checks
Configure health check endpoints:
services:
- type: web
name: my-app
runtime: node
healthCheckPath: /health
Default: / (root path)
Recommended: Add a dedicated /health endpoint that returns 200 OK.
Build Filters
Control when builds are triggered based on changed files:
services:
- type: web
name: frontend
runtime: static
buildFilter:
paths:
- frontend/**
ignoredPaths:
- frontend/README.md
- frontend/**/*.test.js
Behavior:
- If
pathsspecified: Build only when files in those paths change - If
ignoredPathsspecified: Don't build when only ignored files change
Projects and Environments
Organize services into projects with multiple environments:
projects:
- name: my-application
environments:
- name: production
services:
- type: web
name: prod-api
runtime: node
plan: pro
buildCommand: npm ci
startCommand: npm start
databases:
- name: prod-postgres
plan: pro-4gb
networking:
isolation: enabled
permissions:
protection: enabled
- name: staging
services:
- type: web
name: staging-api
runtime: node
plan: starter
buildCommand: npm ci
startCommand: npm start
databases:
- name: staging-postgres
plan: free
Environment features:
networking.isolation: Enable network isolation between environmentspermissions.protection: Require approval for environment changes
Preview Environments
Configure automatic preview environments for pull requests:
previews:
generation: auto_preview # auto_preview | manual | none
Options:
auto_preview: Create preview environment for each PR automaticallymanual: User manually triggers preview creationnone: Disable preview environments
Complete Example
Full-featured Blueprint with multiple services and databases:
services:
# Web service
- type: web
name: web-app
runtime: node
plan: free
region: oregon
buildCommand: npm ci && npm run build
startCommand: npm start
branch: main
autoDeploy: true
healthCheckPath: /health
envVars:
- key: NODE_ENV
value: production
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
- key: JWT_SECRET
sync: false
# Background worker
- type: worker
name: queue-worker
runtime: node
plan: free
buildCommand: npm ci
startCommand: node worker.js
envVars:
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
# Cron job
- type: cron
name: daily-cleanup
runtime: node
schedule: "0 3 * * *"
buildCommand: npm ci
startCommand: node scripts/cleanup.js
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
# Static frontend
- type: web
name: frontend
runtime: static
buildCommand: npm ci && npm run build
staticPublishPath: ./dist
routes:
- type: rewrite
source: /*
destination: /index.html
databases:
- name: postgres
databaseName: app_production
user: app_user
plan: free
postgresMajorVersion: "15"
ipAllowList: []
- name: redis
plan: free
maxmemoryPolicy: allkeys-lru
ipAllowList: []
Validation
Validate your Blueprint before deploying (when CLI command is available):
render blueprint validate
Common validation errors:
- Missing required fields
- Invalid runtime values
- Incorrect environment variable references
- Invalid cron expressions
- Invalid YAML syntax
Best Practices
- Always use
plan: freeby default - Let users upgrade if needed - Mark all secrets with
sync: false- Never hardcode sensitive values - Use
fromDatabasefor database URLs - Automatic internal connection strings - Add health check endpoints - Faster deployment detection
- Use non-interactive build commands - Prevents build hangs
- Bind to
0.0.0.0:$PORT- Required for web services - Use environment variable groups - Share config across services
- Enable autoDeploy: true - Deploy automatically on push
- Set appropriate regions - Choose closest to your users
- Use build filters - Optimize build triggers in monorepos
Additional Resources
- Official Blueprint Specification: https://render.com/docs/blueprint-spec
- Render CLI Documentation: https://render.com/docs/cli
- Environment Variables Guide: https://render.com/docs/environment-variables
references/codebase-analysis.md (verbatim)
Codebase Analysis (Deploy)
Use this reference for framework-specific detection and build/start command selection when preparing a Render deployment.
Node.js Projects
- Read
package.jsonto detect framework (Express, Next.js, Nest.js, Fastify, etc.) - Check
scriptssection for build/start commands - Look for
enginesfield for Node version, or look in.node-versionsor.nvmrc - Detect package manager:
bun.lockb(Bun) ->bun install --frozen-lockfile/bun run startpnpm-lock.yaml(pnpm) ->pnpm install --frozen-lockfile/pnpm startyarn.lock(Yarn) ->yarn install --frozen-lockfile/yarn startpackage-lock.json(npm) ->npm ci/npm startpackage.jsononly (npm fallback) ->npm install/npm start
Python Projects
- Check for dependency files and detect package manager:
uv.lock(uv) ->uv sync/uv run gunicorn app:apppoetry.lock(Poetry) ->poetry install --no-dev/poetry run gunicorn app:appPipfile.lock(pipenv) ->pipenv install --deploy/pipenv run gunicorn app:apprequirements.txt(pip) ->pip install -r requirements.txt/gunicorn app:apppyproject.tomlonly -> check for[tool.uv],[tool.poetry], or use pip
- Detect framework: Django, Flask, FastAPI, Celery, others
- Check for Python version:
.python-version(uv/pyenv)runtime.txt(Render-specific)pyproject.toml(requires-python field)
Go Projects
- Read
go.modfor dependencies - Identify web framework (Gin, Echo, Chi, Fiber, net/http)
- Note Go version from
go.mod
Static Sites
- Look for build output directories (
build/,dist/,site/,public/) - Detect framework: React, Vue, Gatsby, Next.js (static export)
- Check build scripts in
package.json
Docker Projects
- Look for
Dockerfile - Note exposed ports and build stages
- Check for
docker-compose.ymlpatterns
Key Information to Extract
- Build command (e.g.,
npm ci,pip install -r requirements.txt,go build) - Start command (e.g.,
npm start,gunicorn app:app,./bin/app) - Environment variables used in code (API keys, database URLs, secrets)
- Database requirements (PostgreSQL, Redis, MongoDB)
- Port binding (check if app uses an environment variable for port to run on)
references/configuration-guide.md (verbatim)
Render Configuration Guide
Common configuration patterns, best practices, and troubleshooting for Render deployments.
Environment Variables
Required vs Optional Variables
Always declare ALL environment variables in render.yaml, even if values are provided by user later.
Three categories:
- Configuration values (hardcoded):
envVars:
- key: NODE_ENV
value: production
- key: LOG_LEVEL
value: info
- key: API_URL
value: https://api.example.com
- Secrets (user provides):
envVars:
- key: JWT_SECRET
sync: false
- key: STRIPE_SECRET_KEY
sync: false
- key: API_KEY
sync: false
- Auto-generated (Render provides):
envVars:
- key: SESSION_SECRET
generateValue: true
- key: ENCRYPTION_KEY
generateValue: true
Database Connection Patterns
PostgreSQL:
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
Redis:
envVars:
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
Multiple databases:
envVars:
- key: PRIMARY_DB_URL
fromDatabase:
name: postgres-primary
property: connectionString
- key: ANALYTICS_DB_URL
fromDatabase:
name: postgres-analytics
property: connectionString
- key: CACHE_URL
fromDatabase:
name: redis
property: connectionString
Cross-Service References
Reference other services in your account:
services:
- type: web
name: frontend
runtime: node
envVars:
- key: API_URL
fromService:
name: backend-api
type: web
property: host # or hostport, port
- type: web
name: backend-api
runtime: node
Available properties:
host: Service hostnameport: Service porthostport: Combinedhost:port
Environment Variable Groups
Share common configuration across services:
envVarGroups:
- name: common-config
envVars:
- key: NODE_ENV
value: production
- key: LOG_LEVEL
value: info
- key: TZ
value: UTC
services:
- type: web
name: web-app
runtime: node
envVars:
- fromGroup: common-config
- key: PORT
value: 10000
- type: worker
name: worker
runtime: node
envVars:
- fromGroup: common-config
Port Binding
The Port Binding Requirement
CRITICAL: Web services must bind to 0.0.0.0:$PORT
Why this matters:
- Render sets
PORTenvironment variable (default: 10000) - Services must bind to
0.0.0.0(notlocalhostor127.0.0.1) - Health checks fail if port binding is incorrect
- Deployment will fail or service won't receive traffic
Code Examples by Language
Node.js / Express:
const express = require('express');
const app = express();
const PORT = process.env.PORT || 3000;
app.listen(PORT, '0.0.0.0', () => {
console.log(`Server running on port ${PORT}`);
});
Python / Flask:
import os
from flask import Flask
app = Flask(__name__)
if __name__ == '__main__':
port = int(os.environ.get('PORT', 5000))
app.run(host='0.0.0.0', port=port)
Python / Django:
In settings.py:
# Django runs on port specified by environment
ALLOWED_HOSTS = ['*']
Start command in render.yaml:
startCommand: gunicorn config.wsgi:application --bind 0.0.0.0:$PORT
Python / FastAPI:
import os
import uvicorn
from fastapi import FastAPI
app = FastAPI()
if __name__ == "__main__":
port = int(os.environ.get("PORT", 8000))
uvicorn.run(app, host="0.0.0.0", port=port)
Start command:
startCommand: uvicorn main:app --host 0.0.0.0 --port $PORT
Go:
package main
import (
"fmt"
"net/http"
"os"
)
func main() {
port := os.Getenv("PORT")
if port == "" {
port = "3000"
}
http.HandleFunc("/", handler)
fmt.Printf("Server starting on port %s\n", port)
http.ListenAndServe(":"+port, nil)
}
Ruby / Rails:
In config/puma.rb:
port ENV.fetch("PORT") { 3000 }
bind "tcp://0.0.0.0:#{ENV.fetch('PORT', 3000)}"
Rust / Actix:
use actix_web::{App, HttpServer};
use std::env;
#[actix_web::main]
async fn main() -> std::io::Result<()> {
let port = env::var("PORT").unwrap_or_else(|_| "8080".to_string());
let addr = format!("0.0.0.0:{}", port);
HttpServer::new(|| App::new())
.bind(&addr)?
.run()
.await
}
Build Commands
Non-Interactive Flags
Always use non-interactive flags to prevent builds from hanging waiting for input.
npm (Node.js):
buildCommand: npm ci
# NOT: npm install
pip (Python):
buildCommand: pip install -r requirements.txt
# Already non-interactive
apt (System packages):
buildCommand: apt-get update && apt-get install -y libpq-dev
# Use -y flag to auto-confirm
bundler (Ruby):
buildCommand: bundle install --jobs=4 --retry=3
Build with Additional Steps
Node.js with build step:
buildCommand: npm ci && npm run build
Python Django with static files:
buildCommand: pip install -r requirements.txt && python manage.py collectstatic --no-input
Ruby Rails with assets:
buildCommand: bundle install && bundle exec rails assets:precompile
Build Timeouts
Free tier: 15 minutes Paid tiers: Configurable
If builds timeout:
- Optimize dependencies (remove unused packages)
- Use build caching
- Consider pre-building in CI/CD
- Upgrade to paid tier for longer timeouts
Database Connections
Internal vs External URLs
Use internal URLs for better performance:
When using fromDatabase, Render automatically provides internal .render-internal.com URLs:
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
This provides: postgresql://user:pass@postgres.render-internal.com:5432/db
Benefits:
- Lower latency (same data center)
- No external bandwidth charges
- Automatic internal DNS
Connection Pooling
Node.js / PostgreSQL:
const { Pool } = require('pg');
const pool = new Pool({
connectionString: process.env.DATABASE_URL,
ssl: process.env.NODE_ENV === 'production' ? { rejectUnauthorized: false } : false,
max: 20, // Maximum pool size
idleTimeoutMillis: 30000,
connectionTimeoutMillis: 2000,
});
Python / PostgreSQL:
import psycopg2.pool
pool = psycopg2.pool.SimpleConnectionPool(
minconn=1,
maxconn=20,
dsn=os.environ['DATABASE_URL']
)
Django Settings:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'URL': os.environ['DATABASE_URL'],
'CONN_MAX_AGE': 600, # Connection pooling
}
}
Database Migrations
Run migrations during build:
Django:
buildCommand: pip install -r requirements.txt && python manage.py migrate
Rails:
buildCommand: bundle install && bundle exec rails db:migrate
Node.js / Prisma:
buildCommand: npm ci && npx prisma migrate deploy
Free Tier Limitations
What's Included
Free tier provides:
- 1 web service
- 1 PostgreSQL database (1 GB storage, 97 MB RAM)
- 750 hours/month compute
- 512 MB RAM per service
- 0.5 CPU per service
- 100 GB bandwidth/month
Resource Limits
Memory (512 MB):
- Monitor memory usage in logs
- Optimize for memory-constrained environments
- Use lightweight dependencies
CPU (0.5 cores):
- Suitable for low-traffic applications
- Consider upgrading for higher traffic
Spin Down (Free services):
- Services spin down after 15 minutes of inactivity
- First request after spin down takes ~30 seconds (cold start)
- Upgrade to paid tier for always-on services
When to Upgrade
Upgrade to paid plan when:
- Need more than 1 web service
- Need always-on services (no spin down)
- Traffic exceeds free tier limits
- Need more memory/CPU
- Need faster build times
- Need preview environments
Health Checks
Adding Health Check Endpoints
Node.js / Express:
app.get('/health', (req, res) => {
res.status(200).json({
status: 'ok',
timestamp: new Date().toISOString()
});
});
Python / Flask:
@app.route('/health')
def health():
return {'status': 'ok'}, 200
Python / FastAPI:
@app.get("/health")
async def health():
return {"status": "ok"}
Go:
http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte(`{"status":"ok"}`))
})
Configure in render.yaml
services:
- type: web
name: my-app
runtime: node
healthCheckPath: /health
Benefits:
- Faster deployment detection
- Better monitoring
- Automatic restart on health check failures
Common Deployment Issues
Issue 1: Missing Environment Variables
Symptom: Service crashes with "undefined variable" errors
Solution: Add all required env vars to render.yaml:
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
- key: JWT_SECRET
sync: false # User fills in Dashboard
Issue 2: Port Binding Errors
Symptom: EADDRINUSE or health check timeout errors
Solution: Ensure app binds to 0.0.0.0:$PORT:
const PORT = process.env.PORT || 3000;
app.listen(PORT, '0.0.0.0');
Issue 3: Build Hangs
Symptom: Build times out after 15 minutes
Solution: Use non-interactive build commands:
buildCommand: npm ci # NOT npm install
Issue 4: Database Connection Fails
Symptom: ECONNREFUSED on port 5432
Solutions:
- Use
fromDatabasefor automatic internal URLs - Enable SSL for external connections
- Check
ipAllowListsettings
Issue 5: Static Site 404s
Symptom: Client-side routes return 404
Solution: Add SPA rewrite rules:
routes:
- type: rewrite
source: /*
destination: /index.html
Issue 6: Out of Memory (OOM)
Symptom: Service crashes with JavaScript heap out of memory
Solutions:
- Optimize application memory usage
- Reduce dependency size
- Upgrade to higher plan with more RAM
Best Practices Checklist
Environment Variables:
- All env vars declared in render.yaml
- Secrets marked with
sync: false - Database URLs use
fromDatabasereferences
Port Binding:
- App binds to
process.env.PORT - Bind to
0.0.0.0(notlocalhost)
Build Commands:
- Use non-interactive flags (
npm ci,-y, etc.) - Build completes under 15 minutes (free tier)
Start Commands:
- Command starts HTTP server correctly
- Server binds to correct port
Health Checks:
-
/healthendpoint implemented - Returns 200 status code
Database:
- Connection pooling configured
- Using internal URLs (
.render-internal.com) - SSL enabled if needed
Plans:
- Using
plan: freeby default - Documented upgrade path for users
Git Repository:
- render.yaml committed to repository
- Pushed to git remote (GitHub/GitLab/Bitbucket)
- Branch specified in render.yaml (if not main)
Additional Resources
- Blueprint Specification: blueprint-spec.md
- Service Types: service-types.md
- Runtimes: runtimes.md
- Official Render Docs: https://render.com/docs
references/deployment-details.md (verbatim)
Deployment Details
Use this reference for service discovery, configuration patterns, quick commands, and common issues.
Service Discovery
List all services:
list_services()
Returns all services with IDs, names, types, and status.
Get specific service details:
get_service(serviceId: "<id>")
Returns full configuration including environment variables and build/start commands.
List PostgreSQL databases:
list_postgres_instances()
List Key-Value stores:
list_key_value()
Configuration Details
Environment Variables
All environment variables must be declared in render.yaml.
Three patterns for environment variables:
- Hardcoded values (non-sensitive configuration):
envVars:
- key: NODE_ENV
value: production
- key: API_URL
value: https://api.example.com
- Database connections (auto-generated):
envVars:
- key: DATABASE_URL
fromDatabase:
name: postgres
property: connectionString
- key: REDIS_URL
fromDatabase:
name: redis
property: connectionString
- Secrets (user fills in Dashboard):
envVars:
- key: JWT_SECRET
sync: false
- key: API_KEY
sync: false
- key: STRIPE_SECRET_KEY
sync: false
Complete environment variable guide: configuration-guide.md
Port Binding
CRITICAL: Web services must bind to 0.0.0.0:$PORT (NOT localhost). Render sets the PORT environment variable.
Node.js Example:
const PORT = process.env.PORT || 3000;
app.listen(PORT, '0.0.0.0', () => {
console.log(`Server running on port ${PORT}`);
});
Python Example:
import os
port = int(os.environ.get('PORT', 5000))
app.run(host='0.0.0.0', port=port)
Go Example:
port := os.Getenv("PORT")
if port == "" {
port = "3000"
}
http.ListenAndServe(":"+port, handler)
Plan Defaults
Use plan: free unless the user specifies otherwise. Refer to Render pricing for current limits and capacity.
Build Commands
Use non-interactive flags to prevent build hangs:
- npm:
npm ci - yarn:
yarn install --frozen-lockfile - pnpm:
pnpm install --frozen-lockfile - bun:
bun install --frozen-lockfile - pip:
pip install -r requirements.txt - uv:
uv sync - apt:
apt-get install -y <package> - bundler:
bundle install --jobs=4 --retry=3
Database Connections
When services connect to databases in the same Render account, use fromDatabase references for internal URLs.
Health Checks
Optional but recommended: add a /health endpoint for faster deployment detection.
Quick Reference
MCP Tools (Preferred)
# Service Discovery
list_services()
get_service(serviceId: "<id>")
list_postgres_instances()
list_key_value()
# Service Creation
create_web_service(name, runtime, buildCommand, startCommand, ...)
create_static_site(name, buildCommand, publishPath, ...)
create_cron_job(name, runtime, schedule, buildCommand, startCommand, ...)
create_postgres(name, plan, region)
create_key_value(name, plan, region)
# Environment Variables
update_environment_variables(serviceId, envVars: [{key, value}, ...])
# Deployment & Monitoring
list_deploys(serviceId, limit)
list_logs(resource: ["<id>"], level: ["error"])
get_metrics(resourceId, metricTypes: [...])
# Workspace
get_selected_workspace()
list_workspaces()
CLI Commands
# Validate Blueprint
render blueprints validate
# Check workspace
render workspace current -o json
render workspace set
# List services
render services -o json
# View deployment logs
render logs -r <service-id> -o json
# Create deployment
render deploys create <service-id> --wait
Templates by Framework
- Node.js Express: ../assets/node-express.yaml
- Next.js + Postgres: ../assets/nextjs-postgres.yaml
- Django + Worker: ../assets/python-django.yaml
- Static Site: ../assets/static-site.yaml
- Go API: ../assets/go-api.yaml
- Docker: ../assets/docker.yaml
Documentation
- Full Blueprint specification: blueprint-spec.md
- Service types explained: service-types.md
- Runtime options: runtimes.md
- Configuration guide: configuration-guide.md
Common Issues
Issue: Deployment fails with port binding error
Solution: Ensure app binds to 0.0.0.0:$PORT (see Port Binding section above)
Issue: Build hangs or times out
Solution: Use non-interactive build commands (see Build Commands section above)
Issue: Missing environment variables in Dashboard
Solution: All env vars must be declared in render.yaml. Add missing vars with sync: false for secrets.
Issue: Database connection fails
Solution: Use fromDatabase references for internal connection strings.
Issue: Static site shows 404 for routes
Solution: Add rewrite rules to render.yaml for SPA routing:
routes:
- type: rewrite
source: /*
destination: /index.html
For more detailed troubleshooting, see the debug skill or configuration-guide.md.
references/direct-creation.md (verbatim)
Direct Creation (MCP) Details
Use this reference for MCP direct-creation examples and follow-on configuration.
Direct Creation Workflow
Step 1: Analyze Codebase
Use codebase-analysis.md to determine runtime, build/start commands, env vars, and datastores.
Step 2: Create Resources via MCP
Create a Web Service:
create_web_service(
name: "my-api",
runtime: "node", # or python, go, rust, ruby, elixir, docker
repo: "https://github.com/username/repo",
branch: "main", # optional, defaults to repo default branch
buildCommand: "npm ci",
startCommand: "npm start",
plan: "free", # free, starter, standard, pro, pro_max, pro_plus, pro_ultra
region: "oregon", # oregon, frankfurt, singapore, ohio, virginia
envVars: [
{"key": "NODE_ENV", "value": "production"}
]
)
Create a Static Site:
create_static_site(
name: "my-frontend",
repo: "https://github.com/username/repo",
branch: "main",
buildCommand: "npm run build",
publishPath: "dist", # or build, public, out
envVars: [
{"key": "VITE_API_URL", "value": "https://api.example.com"}
]
)
Create a Cron Job:
create_cron_job(
name: "daily-cleanup",
runtime: "node",
repo: "https://github.com/username/repo",
schedule: "0 0 * * *", # Daily at midnight (cron syntax)
buildCommand: "npm ci",
startCommand: "node scripts/cleanup.js",
plan: "free"
)
Create a PostgreSQL Database:
create_postgres(
name: "myapp-db",
plan: "free", # free, basic_256mb, basic_1gb, basic_4gb, pro_4gb, etc.
region: "oregon"
)
Create a Key-Value Store (Redis):
create_key_value(
name: "myapp-cache",
plan: "free", # free, starter, standard, pro, pro_plus
region: "oregon",
maxmemoryPolicy: "allkeys_lru" # eviction policy
)
Step 3: Configure Environment Variables
After creating services, add environment variables:
update_environment_variables(
serviceId: "<service-id-from-creation>",
envVars: [
{"key": "DATABASE_URL", "value": "<connection-string>"},
{"key": "JWT_SECRET", "value": "<secret-value>"},
{"key": "API_KEY", "value": "<api-key>"}
]
)
Note: For database connection strings, get the internal URL from the database details in Dashboard or via get_postgres(postgresId: "<id>").
Step 4: Verify Deployment
Services with autoDeploy: "yes" (default) will deploy automatically when created.
Check deployment status:
list_deploys(serviceId: "<service-id>", limit: 1)
Monitor logs for errors:
list_logs(resource: ["<service-id>"], level: ["error"], limit: 50)
Check health metrics:
get_metrics(
resourceId: "<service-id>",
metricTypes: ["http_request_count", "cpu_usage", "memory_usage"]
)
Back to openai/skills (Skills Catalog for Codex) or Agent skills.