Queues
Ordered collections of prompts for batch processing, with dequeue and status-marking operations.
search_queuescreate_queuelist_queue_itemsadd_prompt_to_queuedequeue_queuemark_queue_itemremove_queue_item
search_queues read-only
Search or list queues (ordered collections of prompts for batch processing).
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | 1-based page number. Default: 1. |
pageSize | 6 | 12 | 24 | 48 | 100 | no | Items per page. Default: 12. |
search | string | no | Full-text search over queue names. Max 200 characters. |
{
"name": "search_queues",
"arguments": {}
}
create_queue write · non-destructive
Create a queue for batch-processing prompts. Add prompts with add_prompt_to_queue, then process them with dequeue_queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Queue name. |
description | string | no | What this queue is for. |
{
"name": "create_queue",
"arguments": {
"name": "..."
}
}
list_queue_items read-only
List items in a queue. Each item tracks a prompt and its processing status (pending, in_progress, succeeded, failed).
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Queue id. |
page | integer | no | 1-based page number. Default: 1. |
pageSize | 6 | 12 | 24 | 48 | 100 | no | Items per page. Default: 20. |
status | "pending" | "in_progress" | "succeeded" | "failed" | no | Filter by processing status. |
{
"name": "list_queue_items",
"arguments": {
"id": "..."
}
}
add_prompt_to_queue write · non-destructive
Add a prompt to a queue for batch processing. Reversible with remove_queue_item.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Queue id. |
promptId | string | yes | Prompt id to enqueue. |
{
"name": "add_prompt_to_queue",
"arguments": {
"id": "...",
"promptId": "..."
}
}
dequeue_queue write · non-destructive
Dequeue the next pending item from a queue. Returns the item with its compiled prompt text (compiledPrompt), or null if the queue is empty. Use mark_queue_item to report the outcome once processing is complete.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Queue id. |
{
"name": "dequeue_queue",
"arguments": {
"id": "..."
}
}
mark_queue_item write · non-destructive
Mark a queue item as succeeded or failed after processing. This is required to move items out of the in_progress state.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Queue id. |
itemId | string | yes | Queue item id, from list_queue_items or dequeue_queue. |
status | "succeeded" | "failed" | yes | Terminal status to set on the item. |
notes | string | no | Optional notes on the outcome, e.g. an error message on failure. |
{
"name": "mark_queue_item",
"arguments": {
"id": "...",
"itemId": "...",
"status": "succeeded"
}
}
remove_queue_item write · idempotent
Remove an item from a queue. Only the queue membership is removed; the prompt itself is not deleted. Reversible with add_prompt_to_queue.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Queue id. |
itemId | string | yes | Queue item id to remove. |
{
"name": "remove_queue_item",
"arguments": {
"id": "...",
"itemId": "..."
}
}