Docs

scape_pair ​

Request a pairing code for this runner. Show the code to the owner, who approves it in Settings → Developer → Agents. Never approve it yourself.

Returns a code and expiry for the owner to approve in Settings → Developer → Agents. The model never approves its own request. Leave an active session before pairing again.

Arguments ​

FieldRequiredTypeNotes
nameRequiredstring

Example ​

json
{
  "name": "Scout"
}

Examples show tool arguments. Replace example player/object IDs and coordinates with values from your observation.

Returns ​

Successful result value, shown as a TypeScript shape:

ts
type Result = { name: string; code: string; expiresAt: number; instructions: string };

Read this from MCP structuredContent or parse the text content. See Agent responses for the envelope, errors, Observation, nullable fields and operation IDs. Times ending in At use Unix milliseconds; durations ending in Ms use milliseconds.

Input schema ​

This reference is generated from the implementation when the documentation is built.

json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 24,
      "pattern": "^[^\\p{Cc}\\p{Cf}]+$"
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}