veryfront__create_schedule
Requires project.runs.write.
Access
No external-service connection is required. Use a Veryfront credential with access to the requested resources.
Call type: Can change resources.
Arguments
Example request
Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__create_schedule",
"arguments": {
"name": "example",
"target": {
"kind": "task",
"id": "example"
},
"schedule": "example"
}
}
}Result
The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.
Full schemas
{
"type": "object",
"properties": {
"project_reference": {
"type": "string",
"description": "Project ID or slug that owns the schedule."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Human-readable schedule name."
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
],
"description": "Kind of scheduled target."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Target identifier. For agent schedules, this is the agent ID."
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Conversation identifier associated with the record."
},
{
"type": "null",
"description": "Conversation identifier that scopes the request."
}
],
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false,
"description": "Typed schedule target."
},
"schedule": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Schedule expression, for example a cron expression."
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "IANA timezone used to evaluate the schedule. Defaults to UTC."
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
],
"description": "Runtime target kind for scheduled runs."
},
"runtime_target_environment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "The runtime target environment id associated with this record."
},
{
"type": "null",
"description": "Provide the runtime target environment id."
}
],
"description": "Environment ID when runtime_target_kind is environment."
},
"runtime_target_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "The runtime target branch id associated with this record."
},
{
"type": "null",
"description": "Provide the runtime target branch id."
}
],
"description": "Branch ID when runtime_target_kind is preview_branch."
},
"config": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Run configuration. For agent schedules, put the run prompt in config.prompt."
},
"timeout_seconds": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Per-run timeout in seconds."
},
"backoff_limit": {
"type": "integer",
"minimum": 0,
"description": "Retry backoff limit for failed scheduled runs."
},
"concurrency_policy": {
"type": "string",
"enum": [
"Allow",
"Forbid",
"Replace"
],
"description": "How overlapping scheduled runs are handled."
},
"max_runs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"description": "The max runs associated with this record."
},
{
"type": "null",
"description": "Provide the max runs."
}
],
"description": "Optional maximum number of scheduled runs."
}
},
"required": [
"name",
"target",
"schedule"
],
"additionalProperties": false,
"description": "Arguments for creating a recurring project schedule. Source-defined schedules (definition_source and the source_* fields) are created by pushing source, so this tool accepts manual schedules only.",
"$schema": "http://json-schema.org/draft-07/schema#"
}{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Schedule ID."
},
"project_id": {
"type": "string",
"format": "uuid",
"description": "Owning project ID."
},
"name": {
"type": "string",
"description": "Human-readable schedule name."
},
"status": {
"type": "string",
"enum": [
"active",
"paused",
"deleting"
],
"description": "Schedule status."
},
"paused_reason": {
"type": [
"string",
"null"
],
"description": "System pause reason when Veryfront pauses the schedule."
},
"paused_at": {
"type": [
"string",
"null"
],
"description": "Timestamp when Veryfront paused the schedule."
},
"last_failure_at": {
"type": [
"string",
"null"
],
"description": "Timestamp of the most recent schedule failure."
},
"last_failure_code": {
"type": [
"string",
"null"
],
"description": "Most recent schedule failure code."
},
"last_failure_message": {
"type": [
"string",
"null"
],
"description": "Most recent schedule failure message."
},
"last_failure_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The last failure run id returned by the tool."
}
],
"description": "Canonical run ID for the most recent schedule failure."
},
"target": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"task",
"workflow",
"agent"
],
"description": "Kind of scheduled target."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Target identifier. For agent schedules, this is the agent ID."
},
"conversation_mode": {
"type": "string",
"enum": [
"create_new",
"existing",
"none"
],
"description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
},
"conversation_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"description": "Conversation identifier associated with this result."
},
{
"type": "null",
"description": "Conversation identifier associated with this result."
}
],
"description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false,
"description": "Typed schedule target."
},
"schedule": {
"type": "string",
"description": "Schedule expression."
},
"timezone": {
"type": "string",
"description": "IANA timezone."
},
"runtime_target_kind": {
"type": "string",
"enum": [
"main_branch",
"environment",
"preview_branch"
],
"description": "Runtime target kind."
},
"runtime_target_environment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The runtime target environment id returned by the tool."
}
],
"description": "Environment ID for environment schedules."
},
"runtime_target_branch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The runtime target branch id returned by the tool."
}
],
"description": "Branch ID for preview branch schedules."
},
"config": {
"type": "object",
"additionalProperties": {
"description": "Additional structured values associated with this result."
},
"description": "Run configuration without internal schedule target metadata."
},
"timeout_seconds": {
"type": "integer",
"description": "Per-run timeout in seconds."
},
"backoff_limit": {
"type": "integer",
"description": "Retry backoff limit."
},
"concurrency_policy": {
"type": "string",
"description": "How overlapping scheduled runs are handled."
},
"definition_source": {
"type": "string",
"enum": [
"manual",
"source"
],
"description": "Whether the schedule is manually managed or source-defined."
},
"source_trigger_id": {
"type": [
"string",
"null"
],
"description": "Source trigger ID for source-defined schedules."
},
"source_path": {
"type": [
"string",
"null"
],
"description": "Source file path for source-defined schedules."
},
"source_hash": {
"type": [
"string",
"null"
],
"description": "Source definition hash for source-defined schedules."
},
"last_scheduled_at": {
"type": [
"string",
"null"
],
"description": "Last scheduled fire time."
},
"last_successful_at": {
"type": [
"string",
"null"
],
"description": "Last successful run time."
},
"health": {
"anyOf": [
{
"type": "object",
"properties": {
"maxStalenessSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"maxStalenessSeconds"
],
"additionalProperties": false,
"description": "Structured health details associated with this tool result."
},
{
"type": "null",
"description": "The health returned by the tool."
}
],
"description": "Optional staleness budget used for schedule health alerting."
},
"max_runs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null",
"description": "The max runs returned by the tool."
}
],
"description": "Optional maximum run count."
},
"run_count": {
"type": "integer",
"minimum": 0,
"description": "Fire reservations counted toward the repetition limit; released reservations are subtracted."
},
"completed_at": {
"type": [
"string",
"null"
],
"description": "Completion time for finite schedules."
},
"created_by": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null",
"description": "The created by returned by the tool."
}
],
"description": "User that created the schedule."
},
"integration_requirements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"integration": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-z0-9][a-z0-9_-]*$"
},
"required_scopes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"maxItems": 50,
"default": []
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9_-]*$"
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Unique identifier for the returned record."
},
"parent": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/properties/integration_requirements/items/properties/resources/items/properties/kind",
"description": "The kind returned by the tool."
},
"id": {
"$ref": "#/properties/integration_requirements/items/properties/resources/items/properties/id",
"description": "Unique identifier for the returned record."
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
}
},
"required": [
"kind",
"id"
],
"additionalProperties": false
},
"maxItems": 50,
"default": []
}
},
"required": [
"integration"
],
"additionalProperties": false
},
"maxItems": 20,
"description": "OAuth scopes and exact provider resources required before the schedule can run.",
"default": []
},
"created_at": {
"type": "string",
"description": "Creation timestamp."
},
"updated_at": {
"type": "string",
"description": "Last update timestamp."
}
},
"required": [
"id",
"project_id",
"name",
"status",
"paused_reason",
"paused_at",
"last_failure_at",
"last_failure_code",
"last_failure_message",
"last_failure_run_id",
"target",
"schedule",
"timezone",
"runtime_target_kind",
"runtime_target_environment_id",
"runtime_target_branch_id",
"config",
"timeout_seconds",
"backoff_limit",
"concurrency_policy",
"definition_source",
"source_trigger_id",
"source_path",
"source_hash",
"last_scheduled_at",
"last_successful_at",
"health",
"max_runs",
"run_count",
"completed_at",
"created_by",
"created_at",
"updated_at"
],
"additionalProperties": false,
"description": "The created active recurring project schedule for a task, workflow, or agent target.",
"$schema": "http://json-schema.org/draft-07/schema#"
}