Send DM embed
discord_
Write
- Toolset
- Direct messages
dm - Context cost
- 638 tokens, estimated2,552 bytes of definition, divided by 4
Send a rich embed as a private direct message to a user. Use discord_ for plain text, or discord_ to post an embed in a channel. Requires the bot to share a server with the user, and the user must allow DMs from server members. Returns the new message ID.
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 |
|---|---|---|---|
| user_ | string | pattern ^\d{17,20}$ | Discord user ID (snowflake) of the DM recipient. |
| contentoptional | string | none | Optional plain text shown above the embed. |
| titleoptional | string | none | Embed title shown in bold at the top. |
| urloptional | string | format uripattern ^https?:// | URL that makes the title clickable. |
| descriptionoptional | string | none | Main body text of the embed (supports Markdown). |
| coloroptional | string | pattern ^#[0-9A-Fa-f]{6}$ | Side-bar color as a hex string, e.g. '#5865F2'. |
| fieldsoptional | array of objects | none | Up to 25 name/value field blocks. Set inline:true on a field to render it side-by-side with adjacent inline fields (up to 3 per row). |
| name (nested, level 1)required | string | none | Field heading. |
| value (nested, level 1)required | string | none | Field body text. |
| inline (nested, level 1) | boolean | none | If true, render this field side-by-side with adjacent inline fields. |
| authoroptional | object | none | Author block shown at the top of the embed. |
| name (nested, level 1)required | string | none | Author display name. |
| icon_ | string | format uripattern ^https?:// | Small icon shown next to the author name. |
| url (nested, level 1) | string | format uripattern ^https?:// | URL the author name links to. |
| thumbnail_ | string | format uripattern ^https?:// | Small image shown in the top-right corner. |
| footeroptional | string | none | Footer text shown at the bottom of the embed. |
| image_ | string | format uripattern ^https?:// | Large image shown below the embed body. |
| timestampoptional | boolean | none | If true, stamp the embed with the current time. |
Output
This tool declares no output schema. Its description says what it returns; this page shows no example rather than invent one.
Related tools
Named in its description
Also in Direct messages
Raw definition (2,552 bytes)
{
"name": "discord_send_dm_embed",
"description": "Send a rich embed as a private direct message to a user. Use discord_send_dm for plain text, or discord_send_embed to post an embed in a channel. Requires the bot to share a server with the user, and the user must allow DMs from server members. Returns the new message ID.",
"inputSchema": {
"type": "object",
"properties": {
"user_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "Discord user ID (snowflake) of the DM recipient."
},
"content": {
"description": "Optional plain text shown above the embed.",
"type": "string"
},
"title": {
"description": "Embed title shown in bold at the top.",
"type": "string"
},
"url": {
"description": "URL that makes the title clickable.",
"type": "string",
"format": "uri",
"pattern": "^https?://"
},
"description": {
"description": "Main body text of the embed (supports Markdown).",
"type": "string"
},
"color": {
"description": "Side-bar color as a hex string, e.g. '#5865F2'.",
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"fields": {
"description": "Up to 25 name/value field blocks. Set inline:true on a field to render it side-by-side with adjacent inline fields (up to 3 per row).",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Field heading."
},
"value": {
"type": "string",
"description": "Field body text."
},
"inline": {
"description": "If true, render this field side-by-side with adjacent inline fields.",
"type": "boolean"
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
}
},
"author": {
"description": "Author block shown at the top of the embed.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Author display name."
},
"icon_url": {
"description": "Small icon shown next to the author name.",
"type": "string",
"format": "uri",
"pattern": "^https?://"
},
"url": {
"description": "URL the author name links to.",
"type": "string",
"format": "uri",
"pattern": "^https?://"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"thumbnail_url": {
"description": "Small image shown in the top-right corner.",
"type": "string",
"format": "uri",
"pattern": "^https?://"
},
"footer": {
"description": "Footer text shown at the bottom of the embed.",
"type": "string"
},
"image_url": {
"description": "Large image shown below the embed body.",
"type": "string",
"format": "uri",
"pattern": "^https?://"
},
"timestamp": {
"description": "If true, stamp the embed with the current time.",
"type": "boolean"
}
},
"required": [
"user_id"
],
"additionalProperties": false
},
"annotations": {
"title": "Send DM embed",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": true
}
}