docs: admin

Author: theboxer

Writerside/m.tree

@@ -8,6 +8,11 @@
 
     <toc-element topic="index.md"/>
     <toc-element topic="Glossary.md"/>
+    <toc-element toc-title="Admin">
+        <toc-element topic="Agents.md"/>
+        <toc-element topic="Context-Providers.md"/>
+        <toc-element topic="Tools.md"/>
+    </toc-element>
     <toc-element toc-title="Configuration">
         <toc-element topic="Configuration_Overview.md"/>
         <toc-element topic="Supported-Services.md"/>

Writerside/topics/Agents.md

@@ -0,0 +1,26 @@
+# Agents
+
+To create an agent, navigate to the Extras -> modAI -> Agents and hit `Create Agent` button.
+
+## Properties
+
+### Name
+Name of the agent, this text will show up in the modAI UI, in the agent selector.
+
+### Description
+Internal description of the agent, doesn't have any special functionality.
+
+### User Groups
+When defined, only users from those user groups will be able to use this agent. SUDO users have an access to every agent.
+
+### Enabled
+If set to `false`, the agent won't be available in the agent selector.
+
+### Model
+Name of the model this agent will use. If not specified, model from appropriate system setting will be used. 
+
+### Prompt
+Custom system prompt for this agent. Can give a specific persona to the agent, or instruct the AI how to use and combine specific tools.
+
+### Advanced Config
+Through advanced config, you can override any model setting (that you have in system settings), or add any additional parameters. The format is same as in system settings.

Writerside/topics/Context-Providers.md

@@ -0,0 +1,22 @@
+# Context Providers
+
+To be able to use context providers through agents, they have to be created and configured from this section.
+
+To create & configure context provider, navigate to the Extras -> modAI -> Context Providers and hit `Create Context Provider` button.
+
+## Properties
+
+### Context Provider Class
+Implementation of the context provider. Every context provider class can have an additional configuration that will show up in the `Config` panel on the right side. Additional context providers can be registered using plugin with `modAIOnContextProviderRegister` event.
+
+### Name
+Name of the context provider, this name has to be unique across all configured context providers.
+
+### Description
+Internal description of the context provider, doesn't have any special functionality.
+
+### Enabled
+If set to `false`, the context provider won't be available for use, even when assigned to agents.
+
+### Additional Config Options
+Every context provider class can expose a different set of additional config options. You can reference a value from system settings by using `ss:system_setting_key` format for the config option's value.

Writerside/topics/Tools.md

@@ -0,0 +1,25 @@
+# Tools
+
+To be able to use tools through agents, or directly from chat, they have to be created and configured from this section.
+
+To create & configure tool, navigate to the Extras -> modAI -> Tools and hit `Create Tool` button.
+
+## Properties
+
+### Tool Class
+Implementation of the tool. Every tool class can have an additional configuration that will show up in the `Config` panel on the right side. Additional tools can be registered using plugin with `modAIOnToolRegister` event. 
+
+### Name
+Name of the tool, this name has to be unique across all configured tools. This is how AI references a tool that it wants to run.
+
+### Description
+Internal description of the tool, doesn't have any special functionality.
+
+### Enabled
+If set to `false`, the tool won't be available for use, even when assigned to agents.
+
+### Default
+When set to `true`, the tool will be available for use in every prompt (without a need to select an agent). Be careful with enabling this on tools as it will increase token usage and can worsen the AI responses.  
+
+### Additional Config Options
+Every tool class can expose a different set of additional config options. You can reference a value from system settings by using `ss:system_setting_key` format for the config option's value.