New users end up in a Rocket.Chat server without guidance. A passive landing page simply doesn't work anymore , it's too easy to overlook, generic, and separate from user intent. That's where the AI Server Guide Agent enters the picture.
This smart Rocket.Chat app starts a tailored conversation with every new user, sorts their persona type (e.g. admin, end-user), and directs them to the most appropriate channels, resources, and communities in real-time.
- 🎉 Create a Welcome Message – Designate a welcoming, customizable message to be sent when new members join.
- 📜 Set Server Rules & Etiquette – Present behavioral expectations and usage guidelines explicitly.
- 📢 Suggest Recommended Channels – Set a list of public channels to be recommended to new users based on their needs.
- 🔁 Assign Default Channels – Auto-join new users to default channels after account creation
- 💬 Execute Slash Commands via Chat Interface - Allows admins and users to trigger server functions directly through a chat interface.
- 📢 Broadcast Messages to Users & Channels – Send announcements or important updates to selected users or multiple channels at once.
- New users are auto-assigned to default rooms, giving them an immediate starting point for discussions.
- Instead of getting lost in a pool of many channels, users can ask queries like:
"Which channel should I join? I’m facing issues setting up my dev environment."
They’ll then receive a recommended list of relevant channels. - They receive a welcome message, making things clearer and helping them get started quickly.
- They are presented with the server rules & etiquette, so they know which guidelines to adhere to from the beginning.
- They can simply use the chat interface to carry out tasks like creating, joining, or leaving a channel, inviting users, or using app functions , all without needing to know the inner workings or remember slash commands.
- Have a Rocket.Chat server ready. If you don't have a server, see this guide.
- Install the Rocket.Chat Apps Engline CLI.
npm install -g @rocket.chat/apps-cliVerify if the CLI has been installed
rc-apps -v # @rocket.chat/apps-cli/1.4.0 darwin-x64 node-v10.15.3 - Clone the GitHub Repository
- Navigate to the repository
- Install app dependencies
- To install private Rocket.Chat Apps on your server, it must be in development mode. Enable Apps development mode by navigating to Administration > General > Apps and turn on "Enable development mode".
- Deploy the app to the server
-
If you are running server locally,
server_urlis http://localhost:3000. If you are running in another port, change the 3000 to the appropriate port. -
usernameis the username of your admin user. -
passwordis the password of your admin user. - Open the App, by navigating to Administration > Marketplace > Private Apps. You should see the app listed there. Click on the App name to open the app.
-
Fork the Project
-
Create your Feature Branch (
git checkout -b feat/AmazingFeature) -
Commit your Changes (
git commit -m 'feat: adds some amazing feature') -
Push to the Branch (
git push origin feat/AmazingFeature) -
Open a Pull Request
Admins can configure the AI Guide Agent to deliver a streamlined onboarding and guidance experience. The following features are supported via conversational commands:
git clone https://github.com/RocketChat/AI_Server_Guide.git
cd AI_Server_Guide
npm install
rc-apps deploy --url <server_url> --username <username> --password <password>
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue.
Don't forget to give the project a star! Thanks again!
Here are some links to examples and documentation: