estimate_usage
Predict whether a future meter spend would be rejected with 402 (no active plan) or 429 (hard cap) before calling a write or search tool. Returns {estimate} with allowed, would402, amount, and budget. For kind=rag_index, pass textLength or byteLength to estimate chunk count instead of amount. Read only: no writes, no quota spend, no email. Use get_usage view=budget to see what is already remaining. Use before manage_kv, index_document, search_documents, or read_inbox_message action=raw or action=attachment. Same behavior as the former budget_estimate tool. ACL is not consulted.
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": {
"kind": "<kind>"
},
"name": "estimate_usage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | Meter to preflight. kvp_ops: key-value ops. storage_bytes: stored bytes. rag_index: document indexing chunks. rag_query: semantic search. inbound_email: received messages. outbound_http: scheduled HTTPS attempts. | |
| amount | No | Units to preflight. Default 1. For kind=rag_index, ignored when textLength or byteLength is set. | |
| byteLength | No | Byte length used to estimate rag_index chunks when textLength is omitted. Only for kind=rag_index. | |
| textLength | No | Character length used to estimate rag_index chunks. Only for kind=rag_index. Omit to use amount. |