Yo

Register this agent with Yo (unauthenticated). Returns a pairing URL and code to show the user, who approves the connection in the Yo app. Then poll check_registration to obtain the API key.

{
  "type": "object",
  "properties": {
    "proposed_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Proposed display name for the agent (e.g. \"banana\", \"devin-home-repo\")"
    },
    "description": {
      "description": "Short description of what this agent does",
      "type": "string",
      "maxLength": 500
    },
    "platform": {
      "description": "Agent platform (e.g. \"cursor\", \"devin\", \"claude-code\")",
      "type": "string",
      "maxLength": 64
    }
  },
  "required": [
    "proposed_name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Check the status of a pairing code from register_agent. On the first poll after the user approves, the response includes the api_key exactly once — store it immediately in your secret mechanism — plus paired_with, the account the agent is now connected to, which you MUST show the user.

{
  "type": "object",
  "properties": {
    "pairing_code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 16,
      "description": "The pairing code returned by register_agent"
    },
    "claim_token": {
      "description": "The claim_token returned by register_agent; required to receive the api_key",
      "type": "string",
      "maxLength": 64
    }
  },
  "required": [
    "pairing_code"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Abort a pairing you started with register_agent. Works while pending and after approval: an already-approved connection is revoked (the API key stops working) so a pairing approved by the wrong account can be undone. Available until the pairing expires, and for 15 minutes after you pick up the API key; later than that, use revoke_self. Then call register_agent again.

{
  "type": "object",
  "properties": {
    "pairing_code": {
      "type": "string",
      "minLength": 1,
      "maxLength": 16,
      "description": "The pairing code returned by register_agent"
    },
    "claim_token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The claim_token returned by register_agent (authorizes the cancellation)"
    }
  },
  "required": [
    "pairing_code",
    "claim_token"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Permanently revoke THIS agent using its API key as the Bearer token. Use when you discover (at any time) that paired_with is not your owner’s account and cancel_registration no longer works. The key stops working immediately; call register_agent to start over.

{
  "type": "object",
  "properties": {
    "confirm": {
      "type": "boolean",
      "const": true,
      "description": "Must be true — revocation is immediate and irreversible"
    }
  },
  "required": [
    "confirm"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Send a Yo — a content-free push notification — to your owner. Requires an agent API key as the Bearer token. Optionally include a context_url the notification tap-through will open.

{
  "type": "object",
  "properties": {
    "context_url": {
      "description": "Optional https or app deep-link URL opened when the user taps the notification",
      "type": "string",
      "maxLength": 2048
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}