Docs/MCP reference

saves_stats

Read only

The game's player saves this month, per environment (public, and preview for the saves behind the preview host): the save budget and what is used, in cents (every load and write is paid from it and it is a hard cap: once it is spent writes stop until the next month or a hosting top-up, while loads go on from a small read reserve), documents, bytes and guest bytes against their quotas, and the save formats seen in a sample of recent saves.

GET/api/agent/saves/stats

Behavior

The game's player saves this month, per environment (public, and preview for the saves behind the preview host): the save budget and what is used, in cents (every load and write is paid from it and it is a hard cap: once it is spent writes stop until the next month or a hosting top-up, while loads go on from a small read reserve), documents, bytes and guest bytes against their quotas, and the save formats seen in a sample of recent saves.

Save contents are never shown.

Input parameters

This tool takes no arguments. Send an empty object: {}.

The descriptions above include conditional requirements. The full schema below shows structural validation; runtime checks also apply.

JSON Schema

Input schema · draft-7
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
Calling this tool

Use its name in your connected MCP client. For the HTTP API, the route is relative to your Convex site URL and requires your agent key as a bearer token. Keep the key on the agent side, outside a game build.