Skip to main content
MIRAGE ships DiscordResource in two runtimes:
  • @struktoai/mirage-node, talks to https://discord.com/api/v10/* directly using a bot token.
  • @struktoai/mirage-browser, stays secret-free: a small proxy server on your backend holds the token and forwards /api/discord/* to https://discord.com/api/v10/*. The browser only ever sees the proxy URL.
Both runtimes expose the same filesystem shape (/discord/<guild>/channels/<channel>/<date>/{chat.jsonl,files/}, /discord/<guild>/members/) and the same shell commands, and both pair with the discord CLI for acting on the server.

Get a bot token

  1. Visit the Discord Developer Portal and create a new application.
  2. Under Bot, add a bot user and copy the Bot Token.
  3. Under Bot → Privileged Gateway Intents, enable:
    • Server Members Intent, required for /discord/<guild>/members/ listings.
    • Message Content Intent, required to read message text in .jsonl history files.
  4. Under OAuth2 → URL Generator, select the bot scope and the following bot permissions:
    • Read Messages/View Channels
    • Read Message History
    • Send Messages (only if you’ll use discord send)
    • Add Reactions (only if you’ll use discord react)
  5. Open the generated URL in a browser and invite the bot to your guild.

Node (server-side)

Browser

The browser package never sees the bot token. Instead, point it at a relative URL that your backend proxies to https://discord.com/api/v10/*, attaching the Authorization: Bot … header server-side.

1. Server: minimal proxy

Discord bot tokens use the Bot <token> auth scheme, not Bearer. Sending Bearer … returns 401 Unauthorized.

2. Browser: wire it up

Calling https://discord.com/api/v10/* directly from a browser fails CORS. The proxy is mandatory, Discord does not set permissive CORS headers for the bot API.

Filesystem layout

The root lists one directory per guild the bot has access to. Each guild contains a channels/ directory with text channels (types 0, 5, 15) and a members/ directory with one .json file per member. Each channel directory contains day-partitioned directories for the 30 days leading up to the channel’s last message, inactive channels show dates around their last activity, not today. Each day directory holds chat.jsonl (one JSON object per message) and a files/ directory with that day’s attachments, cat’ing a blob downloads it from the Discord CDN. Soft errors (403 missing permissions, 404 unknown channel, 429 rate limit) on a single day are swallowed so listings, find, and grep keep working across the rest of the tree. Display names keep their original spelling from Discord (spaces, apostrophes, emoji are all preserved). Only / is replaced with (U+2215) so it cannot collide with a directory boundary. The Discord snowflake ID is appended after __ (double underscore) on guild, channel, member, and attachment names so resource-specific commands can extract it without an extra lookup, and so two same named entities never collide. Quote names containing spaces in shell commands.

Shell commands

Every standard MIRAGE shell command works on the mounted Discord tree: Acting on Discord (sending, editing, reactions, threads, polls, member and guild info, search) goes through the discord CLI when installed; the mounted tree stays read-oriented.

Troubleshooting

Listing members requires the Server Members Intent. Enable it in the Discord Developer Portal under Bot → Privileged Gateway Intents. Without it, members/ returns an empty directory and discord members fails.
Reading message text requires the Message Content Intent. Enable it in the Discord Developer Portal under Bot → Privileged Gateway Intents. Without it, the content field on every message is empty.
Discord bot tokens use the Authorization: Bot <token> scheme, not Bearer. Double-check the proxy server attaches the correct prefix.
The browser cannot call https://discord.com/api/v10/* directly, Discord does not set permissive CORS headers. You must run the proxy server shown above (or your own equivalent) and point proxyUrl at it.
DiscordResource uses an IndexCacheStore (default TTL 600s) to deduplicate guild / channel / member listings, but high-volume reads of .jsonl files can still hit Discord’s per-route rate limits. The HTTP transport retries 429 responses honoring retry_after up to 3 times, repeated failures usually mean you should slow down or scope reads to specific channels.

Examples

See Python Discord Resource for the equivalent Python wiring.