# AI_Server_Guide
**Repository Path**: mirrors_RocketChat/AI_Server_Guide
## Basic Information
- **Project Name**: AI_Server_Guide
- **Description**: AI Server Guide GSoC App
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-23
- **Last Updated**: 2026-02-15
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
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 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.
π¬ How it helps new users
- 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.
βοΈ Installation
- 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-cli
```
Verify 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
```
git clone https://github.com/RocketChat/AI_Server_Guide.git
```
- Navigate to the repository
```
cd AI_Server_Guide
```
- Install app dependencies
```
npm install
```
- 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
```
rc-apps deploy --url --username --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](https://rocketchat.github.io/Rocket.Chat.Apps-engine/)
- [Rocket.Chat Apps TypeScript Definitions Repository](https://github.com/RocketChat/Rocket.Chat.Apps-engine)
- Demo Apps
- [DemoApp](https://github.com/RocketChat/Rocket.Chat.Demo.App)
- [GithubApp](https://github.com/RocketChat/Apps.Github22)
- Community Forums
- [App Requests](https://forums.rocket.chat/c/rocket-chat-apps/requests)
- [App Guides](https://forums.rocket.chat/c/rocket-chat-apps/guides)
- [#rocketchat-apps on Open.Rocket.Chat](https://open.rocket.chat/channel/rocketchat-apps)