records_configure
WriteDeclare the game's verified player records: data only the game's own verified code writes for each signed-in player, never the client, a save, this agent or the creator, so a duel, a trade-free collection or an earned currency can trust it.
/api/agent/records/configureBehavior
Declare the game's verified player records: data only the game's own verified code writes for each signed-in player, never the client, a save, this agent or the creator, so a duel, a trade-free collection or an earned currency can trust it. Give only the kinds to change; null removes one (its rows stay 7 days, so declaring it again in time loses nothing). A document kind holds one JSON value per player and key, such as a caught monster { type: "document", max_bytes: 2048, max_per_player: 500 }; a counter kind holds one whole number per player, such as earned gold { type: "counter", min: 0, max: 1000000000 }.
Choose the sizes for this game: max_bytes up to 65536 (one document as JSON), max_per_player up to 100000, counters within ±9007199254740991; up to 32 kinds; names are 1-32 lowercase letters, digits and dashes starting with a letter, and a kind's type never changes. Only an authoritative room's rules.js result and a replay-verified round's sim.js write records; guests hold none. The response is the stored kinds, anything clamped to the ceilings, and what records cost: the game pays its storage, writes and reads at cost from its hosting credits.
Read the looping-fairplay skill (Progression, collections and economies) before choosing kinds.
Input parameters
kindsRequiredobjectNested schema
{
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]{0,31}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"document",
"counter"
]
},
"max_bytes": {
"type": "integer",
"minimum": 2,
"maximum": 65536
},
"max_per_player": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
}The descriptions above include conditional requirements. The full schema below shows structural validation; runtime checks also apply.
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"kinds": {
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]{0,31}$"
},
"additionalProperties": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"document",
"counter"
]
},
"max_bytes": {
"type": "integer",
"minimum": 2,
"maximum": 65536
},
"max_per_player": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"min": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"max": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
}
},
"required": [
"kinds"
],
"additionalProperties": false
}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.