Docs/MCP reference

player_save_delete

Destructive

Delete one player's save in this game (player is the w… or g… id from players_list; env preview for the save behind the preview host, public by default).

POST/api/agent/players/save/delete

Behavior

Delete one player's save in this game (player is the w… or g… id from players_list; env preview for the save behind the preview host, public by default). The player starts over; the deleted version stays in their own save history for a week, where they can restore it. Use it for a save a bad build corrupted or at the player's request; save contents are never shown to agents.

Input parameters

playerRequired
string
  • Pattern: ^[gw][a-f0-9]{16}$
envOptional
"public" | "preview"

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": {
    "player": {
      "type": "string",
      "pattern": "^[gw][a-f0-9]{16}$"
    },
    "env": {
      "type": "string",
      "enum": [
        "public",
        "preview"
      ]
    }
  },
  "required": [
    "player"
  ],
  "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.