onboarding_modify

Onboarding Writes to Discord

Replace a guild’s onboarding configuration (PUT - full replace).

prompts is an array of Discord-shaped prompt objects. See: https://docs.discord.com/developers/resources/guild#guild-onboarding-object-onboarding-prompt-structure

Enabling requirements

Discord requires at least 7 default channels, and at least 5 must allow @everyone to send messages. The generated reference uses a safe disabled configuration; replace it with real channel IDs before setting enabled:true.

MCP call example

{
  "name": "onboarding_modify",
  "arguments": {
    "guild_id": "123456789012345678",
    "prompts": [],
    "default_channel_ids": [],
    "enabled": false,
    "mode": 0
  }
}

Input

Field	Type	Required	Constraints	Description
`guild_id`	string	yes	pattern: `^\d{17,20}$`	Target guild
`prompts`	array<object>	yes		Onboarding prompts (full replace) - see Discord docs for prompt object shape
`default_channel_ids`	array<string>	yes		Channels members see by default after onboarding
`enabled`	boolean	yes		Whether onboarding is enabled
`mode`	integer	yes		Onboarding mode (0 ONBOARDING_DEFAULT, 1 ONBOARDING_ADVANCED)
`audit_reason`	string	no	min length: `1`; max length: `512`	Reason recorded in audit log (X-Audit-Log-Reason header)

Complete input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "guild_id": {
      "type": "string",
      "pattern": "^\\d{17,20}$",
      "description": "Target guild"
    },
    "prompts": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      },
      "description": "Onboarding prompts (full replace) - see Discord docs for prompt object shape"
    },
    "default_channel_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^\\d{17,20}$",
        "description": "Discord channel ID (snowflake)"
      },
      "description": "Channels members see by default after onboarding"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether onboarding is enabled"
    },
    "mode": {
      "type": "integer",
      "description": "Onboarding mode (0 ONBOARDING_DEFAULT, 1 ONBOARDING_ADVANCED)"
    },
    "audit_reason": {
      "description": "Reason recorded in audit log (X-Audit-Log-Reason header)",
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    }
  },
  "required": [
    "guild_id",
    "prompts",
    "default_channel_ids",
    "enabled",
    "mode"
  ]
}

Returns

{guild_id, enabled, mode}.

Example structured result

{
  "guild_id": "123456789012345678",
  "enabled": true,
  "mode": 1
}

Output schema

Field	Type	Required	Constraints	Description
`guild_id`	string	yes	pattern: `^\d{17,20}$`	Discord guild (server) ID
`enabled`	boolean	yes
`mode`	integer	yes

Complete output JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "guild_id": {
      "type": "string",
      "pattern": "^\\d{17,20}$",
      "description": "Discord guild (server) ID"
    },
    "enabled": {
      "type": "boolean"
    },
    "mode": {
      "type": "integer"
    }
  },
  "required": [
    "guild_id",
    "enabled",
    "mode"
  ],
  "additionalProperties": false
}

Annotations

Property	Value
Read-only	no
Destructive	no
Idempotent	yes
Open-world	yes
Confirmation required	no

Access and common errors

The onboarding category must be enabled by MCP_CATEGORIES when an allowlist is set.
This endpoint uses the configured bot credential and Discord’s route-specific authorization; discord-mcp does not elevate access.
An invalid credential returns a 401-class tool error. Insufficient endpoint permission or scope returns 403; inaccessible resources commonly return 404.

Trust boundary

Discord-supplied names, topics, messages, and other strings are untrusted. Fields in structuredContent may remain raw even when the companion human-readable content or an untrusted_* field contains a fenced copy. Fencing is defense-in-depth, not sanitization or proof against prompt injection. Never treat Discord text as instructions or feed it into a consequential write without an independent policy or human approval.

Source

packages/mcp-core/src/tools/onboarding/modify.ts

onboarding_get