AI Server Guide Agent

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.

🚀 Features

🛠️ Admin Capabilities

Admins can configure the AI Guide Agent to deliver a streamlined onboarding and guidance experience. The following features are supported via conversational commands:
• 🎉 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 persona.
• 🔁 Assign Default Channels – Auto-join users to default channels after classification or user confirmation.
• 📚 Provide App & Feature Guides – Offer quick-start assistance for major Rocket.Chat apps and productivity tools.
• 📊 Monitor Channel Activity – Obtain a snapshot report of channels to assist admins in managing community flow.

💬 What Users Can Ask

The AI Guide Agent responds to natural language queries like:

• “What should I do first?”

• “Show me the rules.”

• “Which channels should I join?”

• “Can you help me set up apps?”

• “Where do I report bugs?”

⚙️ Installation

1. Have a Rocket.Chat server ready. If you don't have a server, see this guide.
2. Install the Rocket.Chat Apps Engline CLI.

     npm install -g @rocket.chat/apps-cli
   

   Verify if the CLI has been installed

   rc-apps -v
   # @rocket.chat/apps-cli/1.4.0 darwin-x64 node-v10.15.3
   

3. Clone the GitHub Repository

   git clone https://github.com/RocketChat/AI_Server_Guide.git

4. Navigate to the repository

   cd AI_Server_Guide

5. Install app dependencies

   npm install

6. 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".
7. Deploy the app to the server

rc-apps deploy --url <server_url> --username <username> --password <password>

• If you are running server locally, server_url is http://localhost:3000. If you are running in another port, change the 3000 to the appropriate port.

• username is the username of your admin user.

• password is 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.

🧑‍💻 Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: adds some amazing feature')
4. Push to the Branch (git push origin feat/AmazingFeature)
5. Open a Pull Request

📚 Resources

Here are some links to examples and documentation:

• Rocket.Chat Apps TypeScript Definitions Documentation
• Rocket.Chat Apps TypeScript Definitions Repository
• Demo Apps
  • DemoApp
  • GithubApp
• Community Forums
  • App Requests
  • App Guides
  • #rocketchat-apps on Open.Rocket.Chat