Skip to main content
Glama
ferelking242

Discord MCP Ultimate

discord_get_onboarding

Read-only

Read a Discord server's onboarding configuration: enabled status, mode, default channels, and all prompts with options, channels, and roles. Read-only; use discord_set_onboarding to change it.

Instructions

Read the server's onboarding configuration: whether it is enabled, its mode (default or advanced), the default channels new members land in, and every onboarding prompt with its options, each option's channels and roles. Requires the COMMUNITY feature. Read-only. Use discord_set_onboarding to change it.

Input Schema

NameRequiredDescriptionDefault
guild_idYesDiscord server (guild) ID (snowflake).

Output Schema

NameRequiredDescriptionDefault
modeYes
enabledYes
promptsYes
default_channel_idsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.0.0

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=true, but the description adds non-obvious context: the COMMUNITY feature requirement (a hard precondition that can make the call fail) and a preview of the returned structure. It stops short of describing error behavior or what happens when onboarding is disabled, keeping it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no filler: the first front-loads what is returned, the second carries the prerequisite, the read-only confirmation, and the alternative tool. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists so return shape need not be spelled out, yet the description still sketches it, and the one parameter is covered by the schema. For a single-param read tool, the prerequisite plus alternative pointer leaves no gap an agent needs filled before calling.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single guild_id parameter is fully documented with type and snowflake pattern in the schema. The description never references guild_id or adds semantics beyond it, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Read') and resource ('server's onboarding configuration') and then enumerates the exact contents returned: enabled flag, mode, default channels, and every prompt with options/channels/roles. That level of specificity makes it unmistakable against siblings like discord_get_welcome_screen or discord_get_guild_settings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit prerequisite ('Requires the COMMUNITY feature') and names the mutation counterpart ('Use discord_set_onboarding to change it'), so an agent knows both the gating condition and the alternative. Nothing about when to select this tool is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools