Create invite
discord_
Write
- Toolset
- Invites
invites - Discord permission
- Create Instant Invite
- Context cost
- 320 tokens, estimated1,279 bytes of definition, divided by 4
Create an invite link for a channel, optionally limiting its lifetime, uses, and membership type. SECURITY: anyone with the returned link can join the server. Requires the Create Instant Invite permission. Returns the invite URL and code.
Risk and annotations
Read-onlyreadOnlyHint | no | Can modify your server. |
|---|---|---|
DestructivedestructiveHint | no | Declared non-destructive. |
IdempotentidempotentHint | no | Repeating the call can have an additional effect. |
Open worldopenWorldHint | yes | Interacts with an external system: Discord. |
Annotations are hints the server declares. Clients use them to decide when to ask you before a call.
Parameters
| Parameter | Type | Rules | Description |
|---|---|---|---|
| channel_ | string | pattern ^\d{17,20}$ | ID (snowflake) of the channel the invite leads to. |
| max_ | integer | 0 to 604800default 86400 | Invite lifetime in seconds, 0–604800 (7 days); 0 means it never expires. Default 86400 (24h). |
| max_ | integer | 0 to 100default 0 | Maximum number of uses, 0–100; 0 means unlimited. Default 0. |
| uniqueoptional | boolean | none | If true, always mint a fresh invite instead of reusing an equivalent existing one. Default false. |
| temporaryoptional | boolean | none | If true, members who join via this invite are removed when they disconnect (unless they get a role). Default false. |
Output
This tool declares no output schema. Its description says what it returns; this page shows no example rather than invent one.
Related tools
Also in Invites
Raw definition (1,279 bytes)
{
"name": "discord_create_invite",
"description": "Create an invite link for a channel, optionally limiting its lifetime, uses, and membership type. SECURITY: anyone with the returned link can join the server. Requires the Create Instant Invite permission. Returns the invite URL and code.",
"inputSchema": {
"type": "object",
"properties": {
"channel_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "ID (snowflake) of the channel the invite leads to."
},
"max_age": {
"default": 86400,
"description": "Invite lifetime in seconds, 0–604800 (7 days); 0 means it never expires. Default 86400 (24h).",
"type": "integer",
"minimum": 0,
"maximum": 604800
},
"max_uses": {
"default": 0,
"description": "Maximum number of uses, 0–100; 0 means unlimited. Default 0.",
"type": "integer",
"minimum": 0,
"maximum": 100
},
"unique": {
"description": "If true, always mint a fresh invite instead of reusing an equivalent existing one. Default false.",
"type": "boolean"
},
"temporary": {
"description": "If true, members who join via this invite are removed when they disconnect (unless they get a role). Default false.",
"type": "boolean"
}
},
"required": [
"channel_id"
],
"additionalProperties": false
},
"annotations": {
"title": "Create invite",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": true
}
}