Browse documentation
← MCP reference

MCP tool

signup_start

Start sign-up for a new account. Ask the person to open the email link and press Confirm, then call signup_wait. Returns a local attempt ID; polling codes and keys stay private. For an existing account, ask the person to run cscale auth login --email you@example.com, open the sign-in link in their email and type the code shown in their terminal.

CLI 0.2.11

Examples

Start sign-up for a new account. Existing accounts sign in and type the terminal code on the emailed link.

{
  "arguments": {
    "email": "you@example.com",
    "key_name": "laptop"
  },
  "name": "signup_start"
}

Input schema

emailrequired · string

Email address for account confirmation.

key_nameoptional · string

Name of the new check key; defaults to cscale on this machine's name.

JSON Schema
{
  "additionalProperties": false,
  "examples": [
    {
      "email": "you@example.com",
      "key_name": "laptop"
    }
  ],
  "properties": {
    "email": {
      "description": "Email address for account confirmation.",
      "type": "string"
    },
    "key_name": {
      "description": "Name of the new check key; defaults to cscale on this machine's name.",
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

Related command: cscale signup.