How to Use CordAi
Getting Started
Welcome to CordAi! This guide will help you understand how to use and get the most out of CordAi in your Discord server.
1. Invite CordAi to Your Server
Click the button below to invite CordAi to your server. You'll need administrator permissions in your Discord server to add the bot.
2. Configure Global Settings
Use the /global-settings command to configure important bot settings:
Available Settings
- Set roles that can manage agents
- Define roles that can view logs
- Specify roles to be alerted about potential bot abuse
3. Create an Agent Using Wizard
The easiest way to create a Data Gatherer agent is with the /wizard data-gatherer command:
Wizard Features
- Interactive, conversational setup process
- Guides you through creating a Data Gatherer agent step-by-step
- Helps with crafting questions and setting up conversation flow
- Creates a ready-to-use agent without technical configuration
The wizard will help you create a fully functioning agent by asking simple questions about what you want the agent to do. This is the fastest way to get started with CordAi.
4. Create Sample Agents
Use the /sample-agents command to quickly create sample agents:
Included Agents
- Vacation Planner: Helps users plan their next vacation
- Event Planner: Helps users plan a community event
- Video Game Buff: Answers questions about video games
These agents provide a starting point for exploring CordAi's capabilities.
Creating and Managing Agents
CordAi uses AI agents to help manage your server. Follow these steps to create and configure your agents:
Creating an Agent
Use the /agents add command to create a new agent in your server.
Required Information
- type - Required, select the agent type:
knowledge-base- For creating information resourcesdata-gatherer- For collecting structured informationdirector- For categorizing requests and directing to appropriate channels or agents
- After creation, you'll be guided through setting:
- Agent name and description
- Agent Type specific settings
Configuring Your Agent
Use /agents edit to modify an existing agent.
Command Options
- name - Required, the name of the agent to edit
Editable Settings
- Agent name and description
- Personality and behavior settings
- Knowledge base content (for Knowledge Base agents)
- Question flow (for Data Gatherer agents)
- Directives and actions (for Director agents)
- Response formatting preferences
Managing Directives
Use /manage-directives to set global instructions that guide how agents behave and interact.
Directive Types
- Background - Provide context about your server or community
- Behavior - Define how agents should act and communicate
- Rule - Set specific rules or limitations for agents
Configuration Options
- Set directives that apply to all agents
- Create specific directives for Data Gatherer, Knowledge Base, or Director agents
- Edit or remove directives as needed
- Up to 1000 characters per directive
Managing Your Agents
Use these commands to manage your agents effectively:
Available Commands
/agents list- View all agents in your server/agents remove- Delete an agent you no longer need/manage-directives- Set global instructions for all agents/my-sessions list- View active agent sessions/my-sessions end- End active sessions/chat-logs- Review conversation history
Note: You need the "Manage Agents" role or Administrator permissions to create and manage agents.
Agent Types
CordAi offers different types of agents, each designed for specific tasks:
Director Agents
Director Agents are designed to categorize user requests and direct them to the appropriate channels or agents. They act as a central point of contact, analyzing user input and triggering actions based on predefined directives.
How Director Agents Work
Director Agents use a combination of prompts and directives to understand user intent and take appropriate actions:
- The agent presents an initial prompt to the user.
- The user responds to the prompt.
- The agent analyzes the user's response and matches it to a directive condition.
- The agent triggers the action associated with the matching directive.
Directives
Directives define the conditions and actions that a Director Agent can perform. Each directive includes:
- A condition that specifies when the directive should be triggered.
- An action to be performed when the condition is met (e.g., creating a channel, starting another agent).
- Optional parameters for the action (e.g., channel name, summary message).
Use Cases
Director Agents are useful for:
- Categorizing support requests and directing them to the appropriate support channel.
- Creating new channels for specific topics or projects.
- Starting other agents to handle specific tasks.
- Automating common tasks in a Discord server.
Knowledge Base Agent
Knowledge Base agents store and provide information about specific topics. They're perfect for creating FAQs, documentation, or help resources. You can define the type of knowledge it possesses, add entries organized in sections, and import knowledge from URLs. The agent can also refresh content from URLs to keep the information up-to-date. The agent is designed to be humble, avoid assumptions, and provide sources for its answers.
Features
- Define the type of knowledge
- Organize knowledge into sections
- Add multiple entries to each section
- Import knowledge from URLs (supports multiple URLs at once)
- Refresh content from URLs to keep information up-to-date
- Manage knowledge entries (add, edit, delete sections and entries)
- Manage knowledge sources (import, refresh, delete sources)
- Humble and avoids making assumptions
- Provides sources for its answers
Setup Guide
To create an effective Knowledge Base agent, follow these guidelines:
- Define Clear Sections: Organize your content into logical sections that represent distinct topics or categories. For example, "History", "Features", and "Usage" for a product KB.
- Write Concise Entries: Each entry should be brief but informative, typically 1-2 sentences. Use bullet points for clarity when appropriate.
- Maintain Consistency: Use consistent formatting and terminology throughout your KB. This makes it easier for users to navigate and understand.
- Regular Updates: Schedule periodic reviews to keep your KB current. Add new entries as needed and remove outdated information.
- Use Examples: Include practical examples to illustrate concepts. For instance, a game history KB might include entries about significant milestones in gaming history.
Section: "The Early Days (1950s-1970s)" - "Tennis for Two" (1958) is considered one of the earliest video games. - The Magnavox Odyssey (1972) was the first home video game console. - Pong (1972) was a commercially successful arcade game. Section: "The Golden Age of Arcades (1970s-1980s)" - Pac-Man (1980) is one of the best-selling arcade games. - Space Invaders (1978) was a cultural phenomenon. - Donkey Kong (1981) introduced Mario.
Common Use Cases
Server FAQ
Create a comprehensive FAQ system that can answer common server-related questions.
Documentation
Maintain technical documentation that users can easily query and understand.
Game Guides
Store and provide detailed game guides, tips, and strategies for players.
Data Gatherer Agent
Data Gatherer agents collect information through structured conversations. They're ideal for surveys, user onboarding, or gathering specific details.
Features
- Define how to start the conversation
- Add questions with expected answer formats
- Set conditional logic for question flow
- Configure how to end the conversation
- Export collected data in various formats
Setup Guide
To create an effective Data Gatherer agent, follow these guidelines:
- Define How To Start: Set clear initial instructions that explain what the agent does and any preliminary information users should know. For example, "First check if users can handle this themselves, then gather basic information before proceeding."
- Create Ordered Questions: Each question needs three components: question text, expected response, and optional condition.
- Set How To End: Define how to conclude the conversation, such as summarizing collected information, providing next steps, or handling early termination requests.
- Consider User Flow: Questions should follow a logical order, with conditions determining which questions to ask based on previous answers.
- Handle Early Exits: Include instructions for what to do if users need to stop the process before completion.
Example Bug Report Agent:
1. Check if users have tried the basic troubleshooting steps - Restarting the game - Restarting the computer - Reinstalling the game or mods 2. Get basic information - in-game username - server they are connecting to 3. Begin bug report questions if they have
Question 1
Question
What type of bug are you experiencing?
Expectation
Choose from options:
- Game crash
- Visual glitch
- Performance issue
- Gameplay mechanicQuestion 2
Question
How can we reproduce this bug?
Expectation
Step-by-step instructions
Note: Video/screenshots helpfulQuestion 3
Question
What other software is running?
Expectation
List active programs:
- Other games
- Recording software
- Mods/pluginsCondition
Only for crashes/performance
1. Summarize bug report details 2. Provide ticket number for tracking 3. Do not ping developers 4. Stop if user requests to end early
Example Community Event Planner:
You are an event planner bot that helps our staff get the necessary information from user to effectively plan and organize community events. You will guide the user through a series of questions to gather details about the event type, audience, budget, location, date/time, goals, sponsors, volunteers, activities, and technical requirements. Be sure to provide clear instructions and ask for specific information to ensure the event is successful. It is important that you get all the necessary details, but be mindful that users may not have all the information readily available. Be patient and guide them through the process. If they are unable to answer a question, provide an option to skip or come back to it later. If they still cannot provide the information, note it down in your summary. Remember to thank the user for their time and wish them luck with their event! (Also, feel free to use reaction emojis on particularly interesting answers)
Welcome the user and inform them this process will take between 5 and 15 minutes to complete. They should be specific and detailed in their responses to ensure the event is planned effectively.
Question 1
Question
What type of event is it?
Expectation
Choose from options:
- Festival
- Fundraiser
- Workshop
- Conference
- OtherCondition
Always ask first
Question 2
Question
Who is the target audience?
Expectation
Describe the target audience:
- Age range (e.g., 18-25, families with children)
- Interests (e.g., music, art, technology)
- Demographics (e.g., students, professionals, seniors)Question 3
Question
What is the budget and funding source for the event?
Expectation
Specify the budget:
- Total amount (e.g., $5,000)
- Funding sources (e.g., donations, ticket sales, sponsors)Question 4
Question
Where will the event be held?
Expectation
Specify the location:
- Indoor or outdoor venue
- Address or general area
- Capacity requirements (e.g., must accommodate 200 people)Question 5
Question
When will the event take place?
Expectation
Specify the date and time:
- Date (MM/DD/YYYY)
- Start time (HH:MM AM/PM)
- End time (HH:MM AM/PM)
- Alternative dates if primary is unavailableQuestion 6
Question
What are the goals of the event?
Expectation
Describe specific, measurable goals:
- Raise money (e.g., $10,000 for charity)
- Increase awareness (e.g., 500 new followers on social media)
- Provide entertainment (e.g., 10 different activities)
- Other (please specify with metrics)Question 7
Question
Are there any potential sponsors for the event?
Expectation
List potential sponsors:
- Companies (e.g., local businesses, with contact information)
- Organizations (e.g., community groups, with contact information)
- Individuals (e.g., local philanthropists, with contact information)Question 8
Question
What is the fundraising goal?
Expectation
Specify the fundraising goal:
- Amount to be raised (e.g., $10,000)
- How the funds will be used (e.g., 50% to charity, 50% for future events)
- Donation tiers (e.g., $50, $100, $500 with corresponding benefits)Condition
Only if the event is a fundraiser (QuestionNumber 1 = Fundraiser)
Question 9
Question
How many volunteers are needed?
Expectation
Specify the volunteer requirements:
- Number of volunteers (e.g., 20 volunteers)
- Roles and responsibilities (e.g., 5 for setup, 10 for activities, 5 for cleanup)
- Time commitments (e.g., 4-hour shifts)
- Special skills needed (e.g., first aid certification, technical expertise)Condition
For events with more than 50 attendees
Question 10
Question
What activities will be included in the event?
Expectation
List detailed activities:
- Music (e.g., local band performance from 7-9 PM)
- Food (e.g., 5 food vendors, dietary restrictions accommodated)
- Games (e.g., trivia contest with prizes)
- Workshops (e.g., 30-minute craft sessions)
- Other (please specify with timing and space requirements)Question 11
Question
What are the technical requirements?
Expectation
List all technical needs:
- Audio/visual equipment (e.g., projector, microphones)
- Power requirements (e.g., number of outlets, generator needs)
- Internet access (e.g., WiFi for vendors)
- Other technical considerationsCondition
For indoor events or events with performances
1. Create a detailed budget breakdown - Include all expected expenses and revenue sources - Add 15% contingency for unexpected costs 2. Secure a venue and confirm availability - Book the location and obtain necessary permits - Arrange site visit to verify space requirements 3. Develop a marketing plan - Use social media, flyers, and other marketing channels - Create timeline for promotional activities 4. Final Output Format - Event Name: [Event Name] - Event Type: [Event Type] - Target Audience: [Target Audience] - Budget: [Budget] - Location: [Location] - Date and Time: [Date and Time] - Goals: [Goals] - Sponsors: [Sponsors] - Volunteers: [Volunteers] - Activities: [Activities] - Technical Requirements: [Requirements]
Common Use Cases
User Onboarding
Guide new users through server registration and role assignment process.
Support Tickets
Collect necessary information before escalating to support staff.
Event Registration
Gather participant details and preferences for server events.
Using Agents
CordAi agents can be activated in four different ways to start conversations with users in your server:
Slash Command Activation
Use the /start command to manually start an agent session.
Command Options
- agent - Select which agent to start (required)
- user - The user to start the conversation for (defaults to you)
- channel - The channel to start in (defaults to current channel)
Common Use Cases
Ticket Support
Staff can start an agent for a user directly in their support ticket to gather information or provide assistance.
Rules Assistance
Users can start an agent to get help understanding server rules and guidelines.
Agent Testing
Admins can easily trigger agents in test channels to verify behavior and responses.
Message Trigger Activation
Quickly start an agent conversation with a message trigger. Put the !agent tag and agent name only the first line, then tag the user on any other line to start the conversation.
Command Format
!agent AgentName@User
Common Use Cases
Ticket Integration
Ticketing bots can trigger agents to automatically gather information when tickets are created.
Bot Integration
Other bots can trigger agents to provide specialized assistance or information.
Game Integration
Game bots can trigger agents to provide game-specific help or tutorials.
Channel Message Trigger
Configure an agent to automatically create threads when users send messages in specific channels. The agent will use their initial message to start the conversation.
Configuration Commands
/thread-triggers add- Set up channel monitoring/thread-triggers role- Manage thread roles/thread-triggers list- View all thread configurations/thread-triggers remove- Stop thread creation for an agent
Common Use Cases
Quick FAQ
Automatically answer common questions in dedicated channels with organized threads.
Simple Q&A
Let users ask questions naturally and get immediate responses in threads.
Technical Support
Provide technical assistance with each issue in its own organized thread.
Note: Once activated, an agent will continue interacting with the user until the conversation is complete, manually ended, or a 15 minute inactivity timer expires.
Permissions & Role Management
Control who can use agents with these features:
- Configure allowed trigger roles during agent setup
- Only users with allowed roles can activate the agent
- Agents will only monitor channels they have access to
- For private threads, additional roles can be automatically added
Global Settings
Configure server-wide settings for CordAi using the /global-settings command.
Role Management
Control access to CordAi features through role assignments:
Role Types
- Manage Agents Roles
- Roles that can create and configure agents
- Can manage directives and agent settings
- Log Viewer Roles
- Roles that can access chat logs
- Can view conversation history and analytics
- Command Trigger Roles
- Roles that can use CordAi commands
- Basic access to non-administrative commands
- Start Agent Roles
- Roles that can start agent conversations
- Can use /start command and message triggers
Role Management Command
/global-settings role- type - Role type ("manage-agents", "log-viewer", "command-trigger", "start-agent")
- action - "add" or "remove" the role
- role - The Discord role to add/remove
Report Settings
Configure how CordAi handles reports and notifications:
Report Settings Command
/global-settings report- type - "set" to configure or "clear" to remove
- role - (When type=set) The role to ping for reports
- Selected role will be notified when reports are filed
- Helps ensure quick response to potential issues
Note: Only server administrators can access and modify global settings.