list_schedules

List the recurring agent launches, most recently updated first, with each one's cron expression, prompt, workflow, next run time, and its latest run.

Scheduleread-onlyidempotentMCP tool

Returns one page; pass the response's nextPageToken back as pagination.cursor for the next. The summary this returns by default holds only the opening of each schedule's prompt, marked by promptTruncated; get_schedule returns one whole, and view VIEW_FULL returns every prompt on the page.

Calling it#

curl -X POST http://127.0.0.1:8787/schedule.v1.ScheduleService/ListSchedules \
  -H 'Content-Type: application/json' \
  -d '{}'

Request#

ListSchedulesRequest#

FieldTypeDescription
paginationPagination

Where to carry on from.

viewView

How much of each record to return, since the panel draws every field and a model reading the same endpoint has a context window to spend.

Response#

ListSchedulesResponse#

FieldTypeDescription
scheduleslist of Schedule

One page of schedules, most recently updated first.

nextPageTokenstring

Pass this back as the pagination cursor for the next page.

Types#

Pagination#

FieldTypeDescription
limitint32

How many rows to return, capped by the server, and left to the server entirely when unset.

cursorstring

The next_page_token a previous reply carried, or unset to start from the beginning.

at most 2048 characters

Schedule#

FieldTypeDescription
idstring

The handle every other call names this schedule by.

namestring

What the panel lists it as.

cronstring

Five fields saying when it fires, in the timezone below.

timezonestring

Which clock the expression is read against, blank for the machine's own.

enabledbool

Whether it is armed, since a paused schedule keeps its record and stops firing.

hideAgentsbool

Whether its launches stay out of the panel's sidebar while still running.

promptstring

The opening prompt every agent it launches is given.

workflowIdstring

Which workflow its agents are filed under, deciding their directory and flags.

nextRunAttimestamp

When the expression next matches, unset while the schedule is paused.

promptTruncatedbool

Whether prompt holds only its opening, which a summary listing returns.

latestRunScheduleRun

The newest firing still on record, unset when it has never fired or the record has aged out.

recentRunslist of ScheduleRun

The newest firings on record, newest first, which only the watch fills.

ScheduleRun#

ScheduleRun is one firing of a schedule, as the job that carried it out stands.

FieldTypeDescription
idint64

The job's own id, which orders firings newest first.

scheduledFortimestamp

Which occurrence of the cron expression this firing stands for.

stateScheduleRunState

Where the firing stands.

attemptint32

Which try this is, starting at one once it has been worked.

maxAttemptsint32

How many tries it is given before it is discarded.

finalizedAttimestamp

When it finished, unset while it is still waiting or working.

messagestring

Why it was skipped or what its last failed attempt said, blank once it has launched.

View#

View is how much of each record a listing returns, so that the panel, which draws every field, and a model reading the same endpoint through a context window ask for different amounts of the same rows.

ValueDescription
VIEW_SUMMARY

Long text is cut to its opening, and the record says which fields were cut.

VIEW_FULL

Every field whole, however long.

ScheduleRunState#

ScheduleRunState is where River holds a firing's job.

ValueDescription
SCHEDULE_RUN_STATE_AVAILABLE

Waiting for a worker to pick it up.

SCHEDULE_RUN_STATE_PENDING

Held back from running until something releases it.

SCHEDULE_RUN_STATE_SCHEDULED

Queued to become available at a later time.

SCHEDULE_RUN_STATE_RUNNING

Being worked right now.

SCHEDULE_RUN_STATE_RETRYABLE

Failed an attempt and waiting to try again.

SCHEDULE_RUN_STATE_COMPLETED

Launched its agent.

SCHEDULE_RUN_STATE_CANCELLED

Skipped on purpose, with the reason in its message.

SCHEDULE_RUN_STATE_DISCARDED

Ran out of attempts, with the last error in its message.