Get invite
discord_
Read-only
- Toolset
- Invites
invites - Context cost
- 400 tokens, estimated1,598 bytes of definition, divided by 4
Look up a single invite by its code: target server and channel, inviter, and expiry. Works for any public invite, limited to the DISCORD_ALLOWED_GUILDS servers when that allow-list is set. This endpoint never returns invite metadata (uses/max_uses/max_age read 0, temporary reads false and created_at null); use discord_ or discord_ for real counters. Read-only. Returns a JSON object.
Risk and annotations
Read-onlyreadOnlyHint | yes | Does not modify your server. |
|---|---|---|
DestructivedestructiveHint | n/a | Not declared: it only applies to tools that write. |
IdempotentidempotentHint | n/a | Not declared. |
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 |
|---|---|---|---|
| invite_ | string | none | The invite code, e.g. 'abc123'. A full discord.gg/abc123 URL is also accepted and stripped. |
Output
Declared by outputSchema: clients receive this shape as structuredContent.
| Field | Type |
|---|---|
| coderequired | string |
| urlrequired | string |
| guild_ | string or null |
| guild_ | string or null |
| channel_ | string or null |
| channel_ | string or null |
| inviterrequired | object or null |
| id (nested, level 1)required | string |
| username (nested, level 1)required | string |
| usesrequired | number |
| max_ | number |
| max_ | number |
| temporaryrequired | boolean |
| created_ | string or null |
| expires_ | string or null |
Related tools
Named in its description
-
List invites, Read-only
discord_list_ invites -
List channel invites, Read-only
discord_list_ channel_ invites
Also in Invites
Raw definition (1,598 bytes)
{
"name": "discord_get_invite",
"description": "Look up a single invite by its code: target server and channel, inviter, and expiry. Works for any public invite, limited to the DISCORD_ALLOWED_GUILDS servers when that allow-list is set. This endpoint never returns invite metadata (uses/max_uses/max_age read 0, temporary reads false and created_at null); use discord_list_invites or discord_list_channel_invites for real counters. Read-only. Returns a JSON object.",
"inputSchema": {
"type": "object",
"properties": {
"invite_code": {
"type": "string",
"description": "The invite code, e.g. 'abc123'. A full discord.gg/abc123 URL is also accepted and stripped."
}
},
"required": [
"invite_code"
],
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"url": {
"type": "string"
},
"guild_id": {
"type": [
"string",
"null"
]
},
"guild_name": {
"type": [
"string",
"null"
]
},
"channel_id": {
"type": [
"string",
"null"
]
},
"channel_name": {
"type": [
"string",
"null"
]
},
"inviter": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"uses": {
"type": "number"
},
"max_uses": {
"type": "number"
},
"max_age": {
"type": "number"
},
"temporary": {
"type": "boolean"
},
"created_at": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"url",
"guild_id",
"guild_name",
"channel_id",
"channel_name",
"inviter",
"uses",
"max_uses",
"max_age",
"temporary",
"created_at",
"expires_at"
],
"additionalProperties": false
},
"annotations": {
"title": "Get invite",
"readOnlyHint": true,
"openWorldHint": true
}
}