Klavis AI 🌟

Klavis AI (YC X25) is an open-source project that provides easy-to-use Multi-Channel Protocols (MCPs) for Slack, Discord, and the Web. This repository aims to empower developers and communities to integrate AI seamlessly into their communication platforms.

Table of Contents

• Features
• Installation
• Usage
• Contributing
• License
• Support

Features ✨

• Open Source: Klavis is completely open source, allowing developers to contribute and customize as needed.
• Multi-Channel Support: Easily deploy AI across Slack, Discord, and Web platforms.
• User-Friendly: Designed for ease of use, making it accessible for both novice and experienced developers.
• Community Driven: Join a growing community of developers and users who contribute to the project.

Installation ⚙️

To get started with Klavis, download the latest release from our Releases page. You will find the necessary files to download and execute. Follow the instructions in the release notes for proper setup.

Prerequisites

Before installing Klavis, ensure you have the following:

• Node.js (version 14 or higher)
• NPM (Node Package Manager)
• Access to a Slack or Discord account for testing

Step-by-Step Installation

1. Clone the Repository:

   git clone https://github.com/alexgolemelectrico/klavis.git
   cd klavis
   

2. Install Dependencies:

   npm install
   

3. Run the Application:

   npm start
   

4. Access the Application: Open your browser and navigate to http://localhost:3000.

Usage 📘

Basic Configuration

To configure Klavis for your Slack or Discord server, you will need to create a configuration file. Here's how:

1. Create a Configuration File:

   {
       "token": "YOUR_SLACK_OR_DISCORD_TOKEN",
       "channel": "YOUR_CHANNEL_ID"
   }
   

2. Run the Application: Ensure that your configuration file is in the root directory, then run:

   npm start
   

Sending Messages

Once the application is running, you can send messages using the following command in your terminal:

curl -X POST -H "Content-Type: application/json" -d '{"text": "Hello from Klavis!"}' http://localhost:3000/send

Example Commands

• Send a Message:

  curl -X POST -H "Content-Type: application/json" -d '{"text": "Your message here"}' http://localhost:3000/send
  

• Get Channel History:

  curl -X GET http://localhost:3000/history
  

Contributing 🤝

We welcome contributions to Klavis! To contribute:

1. Fork the Repository.
2. Create a New Branch:

   git checkout -b feature/YourFeature
   

3. Make Your Changes.
4. Commit Your Changes:

   git commit -m "Add your message"
   

5. Push to the Branch:

   git push origin feature/YourFeature
   

6. Open a Pull Request.

Please read our CONTRIBUTING.md for more details.

License 📄

Klavis is licensed under the MIT License. See the LICENSE file for more details.

Support 💬

For any issues or questions, please visit our Releases page or open an issue in the repository. We are here to help!

Topics 🔍

• AI
• Discord
• LLM
• MCP
• MCP Client
• MCP Server
• Open Source
• Slack

Stay Connected 🌐

Follow us on social media to stay updated:

• Twitter
• Discord
• Slack

Conclusion

Thank you for checking out Klavis! We hope you find it useful for your projects. If you have any feedback or suggestions, feel free to reach out. Together, we can make communication smarter and more efficient.