Estimate the wait for a title
estimate_waitEstimate how long you would wait if you placed a hold today, using the live hold queue, copy counts, and due dates, and see other formats with shorter waits.
Instructions
Estimate how long you would wait if you placed a hold today, from the live hold queue, copy count and due dates. Also lists other formats of the same work with a shorter queue. This is an estimate computed by Stacks, not a figure published by the library.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"title_id": "<title_id>"
},
"name": "estimate_wait"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| library | No | Library system id such as "tpl" (Toronto), "vpl" (Vancouver), "chipublib" (Chicago). Get it from find_library. A city or library name also works. | |
| title_id | Yes | A title_id from search_catalog, e.g. "S234C3970025". | |
| loan_days | No | The library's loan period in days. 21 is typical for books. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| basis | Yes | How the estimate was computed. | |
| holds | Yes | ||
| title | Yes | ||
| format | Yes | ||
| source | Yes | Provenance of the data. | |
| library | Yes | ||
| title_id | Yes | ||
| on_shelf_at | Yes | Up to 8 branches with a copy on the shelf. | |
| available_now | Yes | True if a copy is on a shelf somewhere right now. | |
| circulating_copies | Yes | ||
| estimated_wait_days | Yes | Null when no estimate is possible (e.g. no circulating copies). | |
| faster_alternatives | Yes |