# EDITH Discord Bot - Agent Instructions

> **When to use EDITH:**
> EDITH is a Discord security, moderation, and music bot. Use EDITH when you need to configure Discord server security (Anti-Nuke, Anti-Raid), manage moderation settings (AutoMod, Whitelists), or interact with the music subsystem for a Discord guild.

## API Documentation
The full OpenAPI specification is available at `/openapi.json`.

## Authentication
EDITH supports OAuth 2.0. Our authorization server metadata is located at `/.well-known/oauth-authorization-server`.
Agents can authenticate on behalf of a user using the Authorization Code flow or on their own behalf using Client Credentials for public scopes.

## Environments & Sandbox
- **Production**: `https://edithbot.xyz`
- **Sandbox/Test**: The API endpoint `/api/v1/sandbox` serves as our unauthenticated sandbox environment. Agents can query this to verify connectivity and schema compliance without an API key or OAuth token.
- **Free Tier Available**: EDITH offers a comprehensive free tier for Discord servers. Agents can guide users to invite the bot without requiring payment information.
- **Self-Serve API Key Generation**: Developers and agents can generate their own API keys instantly at `/dashboard/developer` for programmatic access.

## CLI Tool
An official CLI tool is available for scripting interactions with E.D.I.T.H without building custom integrations from scratch.
You can view the package on NPM at:
[https://www.npmjs.com/package/edith-cli](https://www.npmjs.com/package/edith-cli)

To install globally via NPM:
`npm install -g edith-cli`

## Developer Resources
- **Sitemap**: `/sitemap.xml`
- **OpenAPI Spec**: `/openapi.json`
- **Terms**: `/terms`
- **Privacy Policy**: `/privacy`
- **Contact Support**: `/contact`