Discord Toolkit

[chunkanglu]

Checked

• I searched existing ideas and did not find a similar one
• I added a very descriptive title
• I've clearly described the feature request and motivation for it

Feature request

We plan to introduce a Discord integration toolkit similar to the existing Slack toolkit. This would allow for more agentic behavior from language models in interacting with a Discord server and users through Discord bots. We aim to have the tentative feature set of the following as a start:

• Get servers (the bot for functionality is invited into)
• Get text channels of a server
• Fetching the most recent messages of a text channel (with some limit)
• Retrieve a user’s data
• Fetch the members of a server
• Send a message in a text channel
• Delete a message in a text channel
• Ban a user from a server

Motivation

Currently, the functionality related to Discord is limited only to importing data via the DiscordChatLoader which not only requires a lengthy retrieval process, but also is not able to interface with recent information as a result. Yet we see great potential in using language models and agents as part of server moderation among other automations to extend existing server capabilities. For example, being able to retrieve the last 10 messages from a user in a text channel and determine if they should be banned for say inappropriate language. We hope to be able to provide the fundamental tools for people to build these more sophisticated processes.

A previous issue #11584 was created last year with similar intentions but was closed without further development, so clearly there is some interest in this sort of functionality. There also exists a Discord tool in LangchainJS so it seems fitting for one to also be here for consistency.

Proposal (If applicable)

We plan to structure our implementation to be similar to other toolkits, in particular the Slack Toolkit and the existing Discord Toolkit in LangchainJS for consistency. To interface with Discord, we plan to make use of the MIT-licensed discord.py library with all functionality implemented through Discord bots.

Sample Usage

from langchain_community.utilities.discord import DiscordAPIWrapper
from langchain_community.agent_toolkits import DiscordToolkit
from langchain_openai import ChatOpenAI
from langgraph.prebuilt import create_react_agent

# Assuming API key for a Discord bot is set in the environment

discord = DiscordAPIWrapper()
toolkit = DiscordToolkit.from_discord_api_wrapper(discord)
tools = toolkit.get_tools()
llm = ChatOpenAI(model="gpt-4o-mini")
agent_executor = create_react_agent(llm, tools)

example_query = "Get all the names of users inside the server WholesomeServer and ban any users with offensive names."
events = agent_executor.stream(
	{"messages": [("user", example_query)]},
	stream_mode="values",
)
for event in events:
	message = event["messages"][-1]
        print(message)
	... # Do something with the message

Sample Output

2 users with names [offensiveName1] and [offensiveName2] have been banned

Main File Changes

langchain/
├── docs/
│   └── docs/
│       └── integrations/
│           └── toolkits/
│               └── discord.ipynb
└── libs/
    ├── langchain/
    │   └── langchain/
    │       └── tools/
    │           └── __init__.py
    └── community/
        ├── langchain_community/
        │   ├── agent_toolkits/
        │   │   ├── discord/
        │   │   │   ├── __init.py
        │   │   │   └── toolkit.py
        │   ├── tools/
        │   │   ├── __init__.py
        │   │   └── discord/
        │   │       ├── __init__.py
        │   │       ├── base.py
        │   │       ├── get_messages.py
        │   │       ├── get_user.py
        │   │       ├── get_members.py
        │   │       ├── send_message.py
        │   │       ├── delete_message.py
        │   │       └── ban_user.py
        │   └── utilities/
        │       └── discord.py
        └── tests/
            ├── unit_tests/
            │   ├── agent_toolkits/
            │   │   └── test_imports.py
            │   └── tools/
            │       ├── test_imports.py
            │       └── test_signatures.py
            └── integration_tests/
                └── discord/
                    └── test_discord.py

discord.py

• Handles initialization of the Discord API wrapper, ensuring that the API key for the bot account to be controlled is provided and the bot account has the required scopes for a specific server.

base.py

• Contains a new base DiscordTool class that extends BaseTool containing a DiscordAPIWrapper.

get_messages.py, get_user.py, get_members.py, …

• Extends the base DiscordTool class with the specific functionality.
• Each will implement the functionality inside the _run method that is used when an agent uses the tool.

toolkit.py

• Extends BaseToolkit class and lists out the available tools implemented in the get_tools method.

discord.ipynb

• Demo notebook to showcase how to setup and use the toolkit.

(the various) __init__.py

• This Discord tool will be registered in the list.

test_signatures.py, (both) test_imports.py

• This tool will be added to the list of tools tested.

test_discord.py

• This file or similar files may contain any relevant integration tests for the tool.

Timeline

We (a group of 4) will be working on this and aim to submit a PR for early November.