Registers the project if it is new, attaches whatever source you give it, and deploys it using the application's Deployment workflow. Direct applications go to Production; Staged applications go to Development. Returns the live URL, or a deployment id to poll if the build is still running.
**You do not decide whether this project needs git.** Send what you have and SpringRoll works it out:
• a pushed git remote → pass `repositoryUrl` (and `ref` if not the default branch)
• no remote, or uncommitted work → pass `archive`, a base64 tar+gzip of the source:
tar --exclude=node_modules --exclude=.next --exclude=.git --exclude='.env*' \
-czf - . | base64 -w0
• both → SpringRoll builds from git, and falls back to your files if the ref cannot be resolved (an unpushed branch, typically)
• neither, on an app that already exists → redeploys its current source
Upload SOURCE, not build output: SpringRoll runs the build. node_modules, .next, dist, build, out, coverage and .log files are dropped automatically and reported. Every .env file and .git/ is REFUSED outright, naming the offending path: configuration belongs in SpringRoll, not in the bundle. Upload limits are about 3 MB compressed on the wire (a platform request-body cap, not a preference), 20 MB expanded, 2000 files, 512 KB per file; a project past them should pass `repositoryUrl` instead, which SpringRoll clones directly with no size limit. Sending the same files twice is free, because bundles are addressed by content.
Direct to Production skips workflow approvals but keeps production safety checks. Staged applications continue to use explicit promotion and approvals.
View input schema
{
"type": "object",
"properties": {
"application": {
"description": "An existing app's slug or id. Omit on the first ship; `name` implies it.",
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"slug": {
"type": "string",
"minLength": 2,
"maxLength": 63,
"pattern": "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$"
},
"manifest": {
"description": "A SpringRoll manifest. Supersedes the metadata fields below; the source fields still apply.",
"type": "string"
},
"description": {
"type": "string",
"maxLength": 2000
},
"department": {
"type": "string",
"maxLength": 120
},
"supportContact": {
"description": "Team channel or email for users of this app. Required before production.",
"type": "string",
"maxLength": 200
},
"dataClassification": {
"type": "string",
"enum": [
"public",
"internal",
"confidential",
"restricted"
]
},
"tags": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 60
}
},
"repositoryUrl": {
"type": "string",
"format": "uri"
},
"ref": {
"description": "Branch, tag, or full commit SHA. Defaults to the app's default revision.",
"type": "string",
"maxLength": 200
},
"archive": {
"description": "Base64 of a gzipped tar of the project source. Preferred over `files`.",
"type": "string"
},
"files": {
"description": "Path-to-contents map. Use `archive` for anything beyond a few files.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"filesEncoding": {
"type": "string",
"enum": [
"utf-8",
"base64"
]
},
"preferSource": {
"description": "Tie-breaker when both a repository and files are given. Defaults to git.",
"type": "string",
"enum": [
"git",
"upload"
]
},
"framework": {
"type": "string",
"enum": [
"nextjs",
"static"
]
},
"installCommand": {
"type": "string",
"maxLength": 500
},
"buildCommand": {
"type": "string",
"maxLength": 500
},
"outputDirectory": {
"type": "string",
"maxLength": 300
},
"rootDirectory": {
"type": "string",
"maxLength": 300
},
"placement": {
"description": "Optional, provider-neutral hints about what this application needs. SpringRoll chooses the provider and plan; these only inform that choice. Leave out anything you do not actually know: monthly billing quantities remain unknown; ordinary workload hints are inferred from the source and named on the placement receipt, which is more useful to the user than a confident guess.",
"type": "object",
"properties": {
"monthlyUsage": {
"description": "Optional monthly billing quantities supplied by the user or actual usage evidence. Never invent values or default missing fields to zero. CPU-hours mean active CPU time; memory GB-hours include billable wait time and provider minimums. Build minutes do not substitute for Sandbox CPU/memory. Database and object storage are separate from local disk. Cloudflare Worker dispatch requests and CPU are separate from container active vCPU, provisioned memory, disk and regional egress. Rows read/written mean billed rows including indexes, not SQL query counts. Cache commands include internal operations and realtime polling. On redeploy this replaces the previous monthlyUsage forecast; omit the whole object to keep it.",
"type": "object",
"properties": {
"worker": {
"type": "object",
"properties": {
"dispatchRequests": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"cpuMilliseconds": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"runtime": {
"type": "object",
"properties": {
"activeCpuHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"provisionedMemoryGbHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"invocations": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"originTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"build": {
"type": "object",
"properties": {
"minutes": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"activeCpuHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"provisionedMemoryGbHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"starts": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"dataTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"registryStorageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"artifactStorageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"artifactSimpleOperations": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"artifactAdvancedOperations": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"artifactDataTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"container": {
"type": "object",
"properties": {
"billedVcpuSeconds": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"billedMemoryGibSeconds": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"billedDiskGbSeconds": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"egressNaEuGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"egressOceaniaKoreaTaiwanGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"egressOtherGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"database": {
"type": "object",
"properties": {
"computeCuHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"storageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"restoreHistoryGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"extraBranchMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"extraBranchHours": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"snapshotStorageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"publicDataTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"rowsRead": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"rowsWritten": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"cache": {
"type": "object",
"properties": {
"commands": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"storageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"dataTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"durableObject": {
"type": "object",
"properties": {
"billableRequests": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"durationGbSeconds": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"rowsRead": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"rowsWritten": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"storageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"kv": {
"type": "object",
"properties": {
"reads": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"writes": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"deletes": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"lists": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"storageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
},
"objectStorage": {
"type": "object",
"properties": {
"storageGbMonths": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
},
"simpleOperations": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"advancedOperations": {
"type": "integer",
"minimum": 0,
"maximum": 1000000000000000
},
"dataTransferGb": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000000
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"needs": {
"description": "Everything this application needs, in one list. At most one shape of thing being run ('static', 'serverless', 'server', or 'container'), plus any services it needs beside its own code: 'postgres', 'auth', 'storage', 'realtime', 'edge-functions'. A provider that cannot supply an entry is excluded, so ask only for what the app actually uses, and leave the shape out unless the project does something the source does not show.",
"type": "array",
"items": {
"type": "string",
"enum": [
"static",
"serverless",
"server",
"container",
"database",
"postgres",
"auth",
"storage",
"realtime",
"edge-functions"
]
}
},
"expectedRequestsPerMonth": {
"description": "Only if the user actually told you. Do not estimate: an invented number is indistinguishable from a measured one once it gets here, and SpringRoll's own default for an internal tool is more honest than a guess.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"expectedBandwidthGb": {
"description": "Egress in gigabytes a month. Only if the user told you.",
"type": "number",
"minimum": 0
},
"computeVcpu": {
"description": "Sustained vCPU. Fractional is normal.",
"type": "number",
"minimum": 0
},
"memoryMb": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"storageGb": {
"description": "Persistent disk needed, in gigabytes.",
"type": "number",
"minimum": 0
},
"region": {
"description": "A required region, when the data has to stay somewhere specific.",
"type": "string",
"maxLength": 64
},
"coldStartTolerant": {
"description": "False if the first visitor after an idle period must not wait. Set this when the user says the app has to be instant; it excludes plans that sleep, which are otherwise the cheapest ones.",
"type": "boolean"
},
"needsWebSockets": {
"description": "Set true if the app holds a live connection. Inferred from the dependency list otherwise, and getting it wrong puts the app on a runtime that drops the socket on every request.",
"type": "boolean"
},
"needsBackgroundWork": {
"description": "Set true if the app runs jobs or a scheduler outside a request.",
"type": "boolean"
},
"needsPersistentDisk": {
"description": "Set true if the app writes files it expects to read back later.",
"type": "boolean"
},
"productionCritical": {
"description": "Whether a colleague depends on this during their working day. Defaults to true for production and false elsewhere.",
"type": "boolean"
},
"budgetUsdPerMonth": {
"description": "A real ceiling, if the user gave one. Leave it out otherwise: a budget of zero that nobody asked for would exclude every qualified plan with a non-zero estimate.",
"type": "number",
"minimum": 0
}
},
"additionalProperties": false
},
"waitSeconds": {
"description": "How long to wait for the build before returning. Defaults to 20. A real build usually outlasts this; poll springroll.deploy.status after.",
"type": "integer",
"minimum": 0,
"maximum": 60
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 200,
"description": "Required. A stable, caller-generated key. Retrying with the same key returns the original result instead of creating a duplicate."
},
"context": {
"type": "string",
"description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\""
}
},
"required": [
"idempotencyKey",
"context"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}