# ServerAssistantAI ## 1.4 - [ServerAssistantAI](https://wiki.code-solutions.dev/serverassistantai/readme.md): The Ultimate AI Assistant for Your Server. - [Showcase](https://wiki.code-solutions.dev/serverassistantai/readme/showcase.md): This section provides visual examples of ServerAssistantAI in action, demonstrating how the plugin integrates with Minecraft and Discord to provide context-aware responses to players. - [Features](https://wiki.code-solutions.dev/serverassistantai/readme/features.md): ServerAssistantAI is packed with many features designed to enhance player support, engagement, and overall experience on your Minecraft and discord server. - [Test Server](https://wiki.code-solutions.dev/serverassistantai/readme/test-server.md): Test Server IP: test.code-solutions.dev - [How ServerAssistantAI Works](https://wiki.code-solutions.dev/serverassistantai/getting-started/how-serverassistantai-works.md): This section explains how ServerAssistantAI functions in-game and on Discord, providing insight into the plugin's question detection, response generation, and interaction with players. - [Prerequisites](https://wiki.code-solutions.dev/serverassistantai/getting-started/prerequisites.md): Prerequisites for downloading ServerAssistantAI. - [Installation](https://wiki.code-solutions.dev/serverassistantai/getting-started/installation.md): Guide to install ServerAssistantAI on your Minecraft server. - [Commands & Permissions](https://wiki.code-solutions.dev/serverassistantai/getting-started/commands-and-permissions.md): ServerAssistantAI includes the following commands for managing and interacting with the AI assistant. - [Addons](https://wiki.code-solutions.dev/serverassistantai/getting-started/addons.md): ServerAssistantAI supports a variety of addons that can be installed to enhance the plugin's functionality and improve the overall user experience. - [The Basics](https://wiki.code-solutions.dev/serverassistantai/configuration/the-basics.md): Before diving into the detailed configuration options, it's important to understand the basic structure and purpose of the various folders and files used by ServerAssistantAI for configuration. - [Config YAML File](https://wiki.code-solutions.dev/serverassistantai/configuration/config-yaml-file.md): The config.yml file is the main configuration file for ServerAssistantAI, containing various settings that control the AI's behavior, appearance, and performance. - [Credentials YAML File](https://wiki.code-solutions.dev/serverassistantai/configuration/credentials-yaml-file.md): The credentials.yml file is used to store API keys and other credentials required by ServerAssistantAI and its addons. This file is updated dynamically as you install new addons. - [Minecraft Config Folder](https://wiki.code-solutions.dev/serverassistantai/configuration/minecraft-config-folder.md): This section provides an in-depth explanation of each file's purpose, format, and available options in the Minecraft folder directory of the plugin. - [Discord Config Folder](https://wiki.code-solutions.dev/serverassistantai/configuration/discord-config-folder.md): This section provides an in-depth explanation of each file's purpose, format, and available options in the Discord folder directory of the plugin. - [Documents Folder](https://wiki.code-solutions.dev/serverassistantai/configuration/documents-folder.md): The documents folder in the SAAI directory is where all server-related information is stored. This folder can contain multiple files in various formats with relevant information about your server. - [Interaction Messages Folder](https://wiki.code-solutions.dev/serverassistantai/configuration/interaction-messages-folder.md): ServerAssistantAI sends a formatted Discord embed message whenever a player interacts with the AI on both Minecraft and Discord servers, regardless of whether the response is public or private. - [Messages YAML File](https://wiki.code-solutions.dev/serverassistantai/configuration/messages-yaml-file.md): The messages.yml file allows you to customize various messages and responses that ServerAssistantAI sends to players in both Minecraft and Discord. - [Logs Folder](https://wiki.code-solutions.dev/serverassistantai/configuration/logs-folder.md): The logs folder contains comprehensive interaction logs that track all AI assistant interactions for both Minecraft and Discord. - [AI Providers](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/ai-providers.md): ServerAssistantAI supports a wide range of language models from both OpenAI and HuggingFace, including premium and free options, allowing server owners to choose the model that best fits their needs. - [Configuring Providers](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/ai-providers/configuring-providers.md) - [Embedding Provider Options](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/ai-providers/embedding-provider-options.md): Embedding providers allow ServerAssistantAI to find relevant information from the server's documents to include in the context sent to the chat providers. - [Chat (LLM) Provider Options](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/ai-providers/chat-llm-provider-options.md): Chat (LLM) providers include AI language models that generate responses to user queries based on the provided context. - [Question Detection Provider Options](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/ai-providers/question-detection-provider-options.md): Question detection providers analyze user messages to determine if they are asking a question that should be answered by the AI assistant. - [Recommended Models](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/recommended-models.md): ServerAssistantAI supports a wide range of language models from both OpenAI and HuggingFace, including premium and free options, allowing server owners to choose the model that best fits their needs. - [Free Models](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/free-models.md) - [Paid Models](https://wiki.code-solutions.dev/serverassistantai/providers-and-models/paid-models.md) - [FAQs](https://wiki.code-solutions.dev/serverassistantai/faqs-and-support/faqs.md) - [Official Support](https://wiki.code-solutions.dev/serverassistantai/faqs-and-support/official-support.md) - [Troubleshooting](https://wiki.code-solutions.dev/serverassistantai/faqs-and-support/troubleshooting.md) - [API](https://wiki.code-solutions.dev/serverassistantai/developers/api.md): ServerAssistantAI provides a powerful API for developers to integrate the AI assistant's functionality into their own plugins or applications, as well as create Addons for ServerAssistantAI. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://wiki.code-solutions.dev/serverassistantai/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.