guild_get_vanity_url

Guild Read only

Get the guild vanity URL invite (Community/Partner perk).

When to use

Display the configured discord.gg/<code> shortcut and how many times it has been used.

MCP call example

{
  "name": "guild_get_vanity_url",
  "arguments": {
    "guild_id": "123456789012345678"
  }
}

Input

Field	Type	Required	Constraints	Description
`guild_id`	string	yes	pattern: `^\d{17,20}$`	Guild to query

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": "Guild to query"
    }
  },
  "required": [
    "guild_id"
  ]
}

Returns

{code, uses}. code is null if no vanity URL is configured.

Example structured result

{
  "code": "example",
  "uses": 1
}

Output schema

Field	Type	Required	Constraints	Description
`code`	string \| null	yes
`uses`	integer	yes

Complete output JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": [
        "string",
        "null"
      ]
    },
    "uses": {
      "type": "integer"
    }
  },
  "required": [
    "code",
    "uses"
  ],
  "additionalProperties": false
}

Annotations

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

Access and common errors

The guild category must be enabled by MCP_CATEGORIES when an allowlist is set.
Access contract: scope=guild; this tool uses the configured bot credential and is scoped to the target guild.
Required permission bits: MANAGE_GUILD.
Discord still makes the final authorization decision; an inaccessible resource commonly returns 403 or 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/guild/get_vanity_url.ts