Skip to content
All tools

create_referral_invites

Diagnostics & system · macOS · Windows

Effect: write (strongest supported action). Status: gated.

Gated means the tool requires an installed app, a connected account, permission, or runtime availability. Check those requirements on the listed platform before using it.

macOS

Purpose

Records referral invites for the colleagues a user chose to invite and returns a unique referral link per person, so the user can later see who installed or activated LMCP. It does not send anything itself — each returned link can be included in an email or message to that person. `lang` records the language the invite is written in (e.g. "es", "en"). The first call previews; confirm: true records the invites.

Required inputs

Permissions and confirmation

Explicit confirmation parameter: inspect the schema and tool description before any real call. The documentation example keeps confirm false. Obtain user authorization before performing the action.

Full input schema — macOS
{
  "properties": {
    "confirm": {
      "description": "Must be true to record the invites. Without it the call returns a preview and records nothing.",
      "type": "boolean"
    },
    "lang": {
      "description": "ISO language of the invite you're writing (the user's conversation language, e.g. 'es', 'en'). Defaults to the Mac's language.",
      "type": "string"
    },
    "recipients": {
      "description": "The picked recipients.",
      "items": {
        "properties": {
          "email": {
            "description": "Recipient's email",
            "type": "string"
          },
          "name": {
            "description": "Recipient's name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "recipients"
  ],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{
  "confirm": false,
  "recipients": [
    {
      "email": "alex@example.com",
      "name": "Alex Rivera"
    }
  ]
}

Windows

Purpose

Records referral invites for the colleagues a user chose to invite and returns a unique referral link per person, so the user can later see who installed or activated LMCP. It does not send anything itself — each returned link can be included in an email or message to that person. `lang` records the language the invite is written in (e.g. "es", "en"). The first call returns a preview naming the recipients and records nothing; confirm=true records them.

Required inputs

Permissions and confirmation

Explicit confirmation parameter: inspect the schema and tool description before any real call. The documentation example keeps confirm false. Obtain user authorization before performing the action.

Full input schema — Windows
{
  "properties": {
    "confirm": {
      "description": "Must be true to record the invites. Without it, returns a preview.",
      "type": "boolean"
    },
    "lang": {
      "description": "ISO language of the invite you're writing (the user's conversation language, e.g. 'es', 'en').",
      "type": "string"
    },
    "recipients": {
      "description": "The picked recipients.",
      "items": {
        "properties": {
          "email": {
            "description": "Recipient's email",
            "type": "string"
          },
          "name": {
            "description": "Recipient's name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "recipients"
  ],
  "type": "object"
}

Documentation example

Do not execute this example. These concrete inputs refer to a fictional demonstration dataset. Resolve real handles and obtain user authorization before any real call.

{
  "confirm": false,
  "recipients": [
    {
      "email": "alex@example.com",
      "name": "Alex Rivera"
    }
  ]
}