Set nickname
discord_
Write
- Toolset
- Members
members - Discord permissions
- Manage Nicknames, or Change Nickname for the bot itself
- Context cost
- 261 tokens, estimated1,045 bytes of definition, divided by 4
Set or clear a member's server nickname. Pass null (or the string 'null') to clear it. Requires the Manage Nicknames permission (or Change Nickname for the bot itself). To rename another member, their highest role must be below the bot's highest role. The reason is recorded in the audit log.
Risk and annotations
Read-onlyreadOnlyHint | no | Can modify your server. |
|---|---|---|
DestructivedestructiveHint | no | Declared non-destructive. |
IdempotentidempotentHint | yes | Repeating the call with the same arguments has no 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 |
|---|---|---|---|
| guild_ | string | pattern ^\d{17,20}$ | Discord server (guild) ID (snowflake). |
| user_ | string | pattern ^\d{17,20}$ | Discord user ID (snowflake) of the member. |
| nicknamerequired | string or null | string:at most 32 characters null | New nickname (max 32 characters), or null to clear it. |
| reasonoptional | string | none | Optional reason recorded in the server audit log. |
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 Members
-
List members, Read-only
discord_list_ members -
Get member info, Read-only
discord_get_ member_ info -
Kick member, Destructive
discord_kick_ member -
Ban member, Destructive
discord_ban_ member -
Unban member, Write
discord_unban_ member -
Timeout member, Write
discord_timeout_ member -
Search members, Read-only
discord_search_ members -
List bans, Read-only
discord_list_ bans -
Bulk ban, Destructive
discord_bulk_ ban -
Prune inactive members, Destructive
discord_prune_ members
Raw definition (1,045 bytes)
{
"name": "discord_set_nickname",
"description": "Set or clear a member's server nickname. Pass null (or the string 'null') to clear it. Requires the Manage Nicknames permission (or Change Nickname for the bot itself). To rename another member, their highest role must be below the bot's highest role. The reason is recorded in the audit log.",
"inputSchema": {
"type": "object",
"properties": {
"guild_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "Discord server (guild) ID (snowflake)."
},
"user_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "Discord user ID (snowflake) of the member."
},
"nickname": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"description": "New nickname (max 32 characters), or null to clear it."
},
"reason": {
"description": "Optional reason recorded in the server audit log.",
"type": "string"
}
},
"required": [
"guild_id",
"user_id",
"nickname"
],
"additionalProperties": false
},
"annotations": {
"title": "Set nickname",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}
}