Get usage
get_usageCheck remaining monthly screenshot quota, plan limit, and reset date before large capture batches or after quota errors; note that each check consumes one screenshot.
Instructions
Report how many screenshots the configured API key has used this month, the plan's monthly limit, how many are left and when the quota resets. Use it before a large batch of captures or when a capture fails with a quota error. This check itself costs 1 screenshot of the quota, so do not call it routinely.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_usage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| used | Yes | Screenshots used in the current period. | |
| limit | Yes | Screenshots included per period on this plan. | |
| period | Yes | ||
| remaining | Yes | ||
| resets_on | Yes | Date (UTC) the monthly quota next resets. | |
| percent_used | Yes | ||
| quota_restart_date | Yes | `quotaRestartDate` exactly as the API reports it. |