A platform for community discussion. Free, open, simple.
DEV: Add the ability to register an AI module for data explorer (#38891)
Natalie Tay8cf063758300
diff --git a/plugins/discourse-ai/admin/assets/javascripts/discourse/routes/admin-plugins/show/discourse-ai-features/edit.js b/plugins/discourse-ai/admin/assets/javascripts/discourse/routes/admin-plugins/show/discourse-ai-features/edit.jsindex d2ced40d880..370bf528bb5 100644--- a/plugins/discourse-ai/admin/assets/javascripts/discourse/routes/admin-plugins/show/discourse-ai-features/edit.js+++ b/plugins/discourse-ai/admin/assets/javascripts/discourse/routes/admin-plugins/show/discourse-ai-features/edit.js@@ -14,8 +14,6 @@ export default class AdminPluginsShowDiscourseAiFeaturesEdit extends DiscourseRoconst { site_settings } = await ajax("/admin/config/site_settings.json", {data: {filter_area: `ai-features/${currentFeature.module_name}`,- plugin: "discourse-ai",- category: "discourse_ai",},});diff --git a/plugins/discourse-ai/admin/assets/javascripts/discourse/templates/admin-plugins/show/discourse-ai-features/edit.gjs b/plugins/discourse-ai/admin/assets/javascripts/discourse/templates/admin-plugins/show/discourse-ai-features/edit.gjsindex cb4c5044532..0e3bf169261 100644--- a/plugins/discourse-ai/admin/assets/javascripts/discourse/templates/admin-plugins/show/discourse-ai-features/edit.gjs+++ b/plugins/discourse-ai/admin/assets/javascripts/discourse/templates/admin-plugins/show/discourse-ai-features/edit.gjs@@ -26,51 +26,91 @@ export default <template>class="ai-feature-editor"as |form|>- {{#each @model.settingGroups as |group|}}- <form.Section @title={{i18n group.titleKey}}>- {{#each group.settings as |settingName|}}- {{#let (@controller.findSetting settingName) as |setting|}}- {{#if setting}}- <form.Field- @name={{setting.setting}}- @title={{setting.humanized_name}}- @description={{if- (eq setting.type "bool")- null- setting.description- }}- @format="large"- @validation={{@controller.getValidationFor setting}}- @type={{if- (eq setting.type "bool")- "checkbox"- (if- (eq setting.type "integer")- "input-number"+ {{#if @model.settingGroups.length}}+ {{#each @model.settingGroups as |group|}}+ <form.Section @title={{i18n group.titleKey}}>+ {{#each group.settings as |settingName|}}+ {{#let+ (@controller.findSetting settingName)+ as |setting|+ }}+ {{#if setting}}+ <form.Field+ @name={{setting.setting}}+ @title={{setting.humanized_name}}+ @description={{if+ (eq setting.type "bool")+ null+ setting.description+ }}+ @format="large"+ @validation={{@controller.getValidationFor setting}}+ @type={{if+ (eq setting.type "bool")+ "checkbox"(if- (eq setting.type "enum")- "select"+ (eq setting.type "integer")+ "input-number"(if- (eq setting.type "category_list")- "custom"- (if (eq setting.type "list") "custom" "input")+ (eq setting.type "enum")+ "select"+ (if+ (eq setting.type "category_list")+ "custom"+ (if+ (eq setting.type "list") "custom" "input"+ )+ )))- )- }}- as |field|- >- <AiFeatureSettingField- @Control={{field.Control}}- @setting={{setting}}- @field={{field}}- />- </form.Field>- {{/if}}- {{/let}}- {{/each}}- </form.Section>- {{/each}}+ }}+ as |field|+ >+ <AiFeatureSettingField+ @Control={{field.Control}}+ @setting={{setting}}+ @field={{field}}+ />+ </form.Field>+ {{/if}}+ {{/let}}+ {{/each}}+ </form.Section>+ {{/each}}+ {{else}}+ {{#each @model.feature_settings as |setting|}}+ <form.Field+ @name={{setting.setting}}+ @title={{setting.humanized_name}}+ @description={{if+ (eq setting.type "bool")+ null+ setting.description+ }}+ @format="large"+ @type={{if+ (eq setting.type "bool")+ "checkbox"+ (if+ (eq setting.type "integer")+ "input-number"+ (if+ (eq setting.type "enum")+ "select"+ (if (eq setting.type "list") "custom" "input")+ )+ )+ }}+ as |field|+ >+ <AiFeatureSettingField+ @Control={{field.Control}}+ @setting={{setting}}+ @field={{field}}+ />+ </form.Field>+ {{/each}}+ {{/if}}<form.Actions><form.Submit /></form.Actions>diff --git a/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_agents_controller.rb b/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_agents_controller.rbindex ba12986c9e0..bdf7f4994cc 100644--- a/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_agents_controller.rb+++ b/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_agents_controller.rb@@ -15,9 +15,10 @@ module DiscourseAi.map { |agent| LocalizedAiAgentSerializer.new(agent, root: false) }tools =- DiscourseAi::Agents::Agent.all_available_tools.map do |tool|- AiToolSerializer.new(tool, root: false)- end+ (+ DiscourseAi::Agents::Agent.all_available_tools ++ DiscourseAi::Agents::Agent.external_tools+ ).map { |tool| AiToolSerializer.new(tool, root: false) }AiTool.where(enabled: true)diff --git a/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_features_controller.rb b/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_features_controller.rbindex 5419ab4614d..1030660df99 100644--- a/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_features_controller.rb+++ b/plugins/discourse-ai/app/controllers/discourse_ai/admin/ai_features_controller.rb@@ -6,7 +6,8 @@ module DiscourseAirequires_plugin PLUGIN_NAMEdef index- render json: serialize_modules(DiscourseAi::Configuration::Module.all)+ modules = DiscourseAi::Configuration::Module.all.select(&:visible?)+ render json: serialize_modules(modules)enddef editdiff --git a/plugins/discourse-ai/app/models/ai_agent.rb b/plugins/discourse-ai/app/models/ai_agent.rbindex 6db7bfc23cd..1c9094a04f8 100644--- a/plugins/discourse-ai/app/models/ai_agent.rb+++ b/plugins/discourse-ai/app/models/ai_agent.rb@@ -261,11 +261,10 @@ class AiAgent < ActiveRecord::Baseinner_name = inner_name.gsub("Tool", "")inner_name = "List#{inner_name}" if %w[Categories Tags].include?(inner_name)- begin- klass = "DiscourseAi::Agents::Tools::#{inner_name}".constantize- options[klass] = current_options if current_options- rescue StandardError- end+ klass =+ "DiscourseAi::Agents::Tools::#{inner_name}".safe_constantize ||+ DiscourseAi::Agents::Agent.external_tool_by_name(inner_name)+ options[klass] = current_options if klass && current_optionsendforce_tool_use << klass if should_force_tool_usediff --git a/plugins/discourse-ai/db/fixtures/agents/603_ai_agents.rb b/plugins/discourse-ai/db/fixtures/agents/603_ai_agents.rbindex c14d327cf41..7290ab7f629 100644--- a/plugins/discourse-ai/db/fixtures/agents/603_ai_agents.rb+++ b/plugins/discourse-ai/db/fixtures/agents/603_ai_agents.rb@@ -9,6 +9,10 @@ ai_agents_is_view =return if ai_agents_is_viewsummarization_agents = [DiscourseAi::Agents::Summarizer, DiscourseAi::Agents::ShortSummarizer]+external_agent_ids =+ DiscourseAi::Agents::Agent.system_agents.filter_map do |klass, id|+ id unless DiscourseAi::Agents::Agent.send(:builtin_system_agents).key?(klass)+ enddef from_setting(setting_name)DB@@ -29,6 +33,8 @@ DiscourseAi::Agents::Agent.system_agents.each do |agent_class, id|if agent_class == DiscourseAi::Agents::WebArtifactCreator# this is somewhat sensitive, so we default it to staffagent.allowed_group_ids = [Group::AUTO_GROUPS[:staff]]+ elsif external_agent_ids.include?(id)+ agent.allowed_group_ids = [Group::AUTO_GROUPS[:admins]]elsif summarization_agents.include?(agent_class)# Copy group permissions from site settings.default_groups = [Group::AUTO_GROUPS[:staff], Group::AUTO_GROUPS[:trust_level_1]]diff --git a/plugins/discourse-ai/lib/agents/agent.rb b/plugins/discourse-ai/lib/agents/agent.rbindex aea6de12d2d..ee45a06392c 100644--- a/plugins/discourse-ai/lib/agents/agent.rb+++ b/plugins/discourse-ai/lib/agents/agent.rb@@ -45,48 +45,24 @@ module DiscourseAienddef system_agents- @system_agents ||= {- General => -1,- SqlHelper => -2,- Artist => -3,- SettingsExplorer => -4,- Researcher => -5,- Creative => -6,- DiscourseHelper => -8,- GithubHelper => -9,- WebArtifactCreator => -10,- Summarizer => -11,- ShortSummarizer => -12,- Designer => -13,- ForumResearcher => -14,- ConceptFinder => -15,- ConceptMatcher => -16,- ConceptDeduplicator => -17,- CustomPrompt => -18,- SmartDates => -19,- MarkdownTableGenerator => -20,- PostIllustrator => -21,- Proofreader => -22,- TitlesGenerator => -23,- Tutor => -24,- Translator => -25,- ImageCaptioner => -26,- LocaleDetector => -27,- PostRawTranslator => -28,- TopicTitleTranslator => -29,- ShortTextTranslator => -30,- SpamDetector => -31,- ContentCreator => -32,- ReportRunner => -33,- Discover => -34,- ChatThreadTitler => -35,- }+ sync_external_registry!+ @system_agents ||= builtin_system_agentsenddef system_agents_by_id@system_agents_by_id ||= system_agents.invertend+ def external_tool_by_name(name)+ sync_external_registry!+ @external_tools_by_name[name]+ end++ def external_tools+ sync_external_registry!+ @external_tools_by_name.values+ end+def all(user:)# listing tools has to be dynamic cause site settings may changeAiAgent.all_agents.filter do |agent|@@ -178,6 +154,92 @@ module DiscourseAitoolsend++ def external_agent_id(agent_klass)+ -(Digest::SHA1.hexdigest(agent_klass.to_s).to_i(16) % 1_000_000 + 1_000_000)+ end++ private++ def sync_external_registry!+ configs = external_feature_configs+ signature = configs.hash+ return if @external_registry_signature == signature++ @external_registry_signature = signature+ external_agents = {}+ external_tools_by_name = {}++ configs.each do |config|+ agent_klass = config[:agent_klass]+ next if agent_klass.nil?+ next if external_agents.key?(agent_klass)+ next if builtin_system_agents.key?(agent_klass)++ external_agents[agent_klass] = config[:agent_id]++ agent_klass.new.tools.each do |tool_klass|+ tool_name = tool_klass.to_s.split("::").last+ next if "DiscourseAi::Agents::Tools::#{tool_name}".safe_constantize+ external_tools_by_name[tool_name] ||= tool_klass+ end+ end++ new_system_agents = builtin_system_agents.merge(external_agents)+ @system_agents_by_id = nil if @system_agents != new_system_agents+ @system_agents = new_system_agents+ @external_tools_by_name = external_tools_by_name+ end++ def external_feature_configs+ return [] if !DiscoursePluginRegistry.respond_to?(:_raw_external_ai_features)++ DiscoursePluginRegistry+ ._raw_external_ai_features+ .pluck(:value)+ .each do |config|+ config[:agent_id] ||= external_agent_id(config[:agent_klass]) if config[:agent_klass]+ end+ end++ def builtin_system_agents+ @builtin_system_agents ||= {+ General => -1,+ SqlHelper => -2,+ Artist => -3,+ SettingsExplorer => -4,+ Researcher => -5,+ Creative => -6,+ DiscourseHelper => -8,+ GithubHelper => -9,+ WebArtifactCreator => -10,+ Summarizer => -11,+ ShortSummarizer => -12,+ Designer => -13,+ ForumResearcher => -14,+ ConceptFinder => -15,+ ConceptMatcher => -16,+ ConceptDeduplicator => -17,+ CustomPrompt => -18,+ SmartDates => -19,+ MarkdownTableGenerator => -20,+ PostIllustrator => -21,+ Proofreader => -22,+ TitlesGenerator => -23,+ Tutor => -24,+ Translator => -25,+ ImageCaptioner => -26,+ LocaleDetector => -27,+ PostRawTranslator => -28,+ TopicTitleTranslator => -29,+ ShortTextTranslator => -30,+ SpamDetector => -31,+ ContentCreator => -32,+ ReportRunner => -33,+ Discover => -34,+ ChatThreadTitler => -35,+ }.freeze+ endenddef iddiff --git a/plugins/discourse-ai/lib/configuration/feature.rb b/plugins/discourse-ai/lib/configuration/feature.rbindex 43550246793..fc8d416b067 100644--- a/plugins/discourse-ai/lib/configuration/feature.rb+++ b/plugins/discourse-ai/lib/configuration/feature.rb@@ -307,7 +307,7 @@ module DiscourseAienddef all- [+ base = [summarization_features,search_features,discord_features,@@ -320,6 +320,21 @@ module DiscourseAiai_automation_report_scripts,ai_automation_triage_scripts,].flatten++ # external features from plugin registry+ DiscoursePluginRegistry.external_ai_features.each do |entry|+ module_id = DiscourseAi::Configuration::Module.external_module_id(entry[:module_name])+ setting_name = "#{entry[:module_name]}_#{entry[:feature]}_agent"+ base << new(+ entry[:feature].to_s,+ setting_name,+ module_id,+ entry[:module_name].to_s,+ enabled_by_setting: entry[:enabled_by_setting],+ )+ end++ baseenddef find_features_using(agent_id:)@@ -382,19 +397,18 @@ module DiscourseAiattr_reader :name, :agent_setting, :module_id, :module_namedef enabled?- @enabled_by_setting.blank? || SiteSetting.get(@enabled_by_setting)+ return true if @enabled_by_setting.blank?+ return false unless SiteSetting.respond_to?(@enabled_by_setting)+ SiteSetting.get(@enabled_by_setting)enddef agent_idsif @agent_ids_lookup@agent_ids_lookup.callelse+ return [] unless SiteSetting.respond_to?(agent_setting)id = SiteSetting.get(agent_setting).to_i- if id != 0- [id]- else- []- end+ id != 0 ? [id] : []endendenddiff --git a/plugins/discourse-ai/lib/configuration/module.rb b/plugins/discourse-ai/lib/configuration/module.rbindex 03862c86698..57a0e924f21 100644--- a/plugins/discourse-ai/lib/configuration/module.rb+++ b/plugins/discourse-ai/lib/configuration/module.rb@@ -42,6 +42,10 @@ module DiscourseAiAUTOMATION_TRIAGE_ID = 11class << self+ def external_module_id(module_name)+ Digest::SHA1.hexdigest(module_name.to_s).to_i(16) % 100_000 + 1000+ end+def allbase_modules = [new(@@ -118,10 +122,35 @@ module DiscourseAi)end+ # external modules from plugin registry+ DiscoursePluginRegistry+ .external_ai_features+ .group_by { |e| e[:module_name] }+ .each do |mod_name, entries|+ module_id = external_module_id(mod_name)+ features =+ entries.map do |e|+ setting_name = "#{mod_name}_#{e[:feature]}_agent"+ DiscourseAi::Configuration::Feature.new(+ e[:feature].to_s,+ setting_name,+ module_id,+ mod_name.to_s,+ enabled_by_setting: e[:enabled_by_setting],+ )+ end+ base_modules << new(+ module_id,+ mod_name,+ features:,+ extra_check: -> { features.any?(&:enabled?) },+ visible: entries.any? { |e| e.fetch(:visible, true) },+ )+ end+base_modulesend- # Privatedef has_scripts?(script_names)DB.query_single(@@ -137,18 +166,30 @@ module DiscourseAiendend- def initialize(id, name, enabled_by_setting: nil, features: [], extra_check: nil)+ def initialize(+ id,+ name,+ enabled_by_setting: nil,+ features: [],+ extra_check: nil,+ visible: true+ )@id = id@name = name@enabled_by_setting = enabled_by_setting@features = features@extra_check = extra_check+ @visible = visibleendattr_reader :id, :name, :enabled_by_setting, :features+ def visible?+ @visible+ end+def enabled?- return @extra_check.call if enabled_by_setting.blank? && @extra_check.present?+ return @extra_check.present? ? @extra_check.call : true if enabled_by_setting.blank?enabled_setting = SiteSetting.get(enabled_by_setting)diff --git a/plugins/discourse-ai/plugin.rb b/plugins/discourse-ai/plugin.rbindex cd103ec4968..e26af83a2b7 100644--- a/plugins/discourse-ai/plugin.rb+++ b/plugins/discourse-ai/plugin.rb@@ -74,6 +74,9 @@ require_relative "lib/mcp/oauth_discovery"require_relative "lib/mcp/oauth_client_registration"require_relative "lib/mcp/oauth_flow"+# Other plugins can register features through this register.+DiscoursePluginRegistry.define_filtered_register(:external_ai_features)+DiscourseAi::Configuration::Module::NAMES.each do |module_name|register_site_setting_area("ai-features/#{module_name}")enddiff --git a/plugins/discourse-ai/spec/configuration/feature_register_spec.rb b/plugins/discourse-ai/spec/configuration/feature_register_spec.rbnew file mode 100644index 00000000000..c8d401fe416--- /dev/null+++ b/plugins/discourse-ai/spec/configuration/feature_register_spec.rb@@ -0,0 +1,53 @@+# frozen_string_literal: true++unless defined?(FakeExternalAgent)+ class FakeExternalAgent < DiscourseAi::Agents::Agent+ def tools+ []+ end++ def system_prompt+ "Test agent"+ end+ end+end++describe DiscourseAi::Configuration::Feature do+ fab!(:fake_plugin) do+ plugin = Plugin::Instance.new+ plugin.path = "#{Rails.root}/spec/fixtures/plugins/my_plugin/plugin.rb"+ plugin+ end++ before do+ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_plugin,+ feature: :test_feature,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: nil,+ },+ fake_plugin,+ )+ end++ after do+ DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|+ entry[:value][:module_name] == :test_plugin+ end+ end++ describe ".all with filtered registry" do+ it "includes features from the external AI features registry" do+ all_features = described_class.all+ test_feature = all_features.find { |f| f.name == "test_feature" }+ expect(test_feature).to be_present+ end++ it "assigns the correct agent setting name" do+ all_features = described_class.all+ test_feature = all_features.find { |f| f.name == "test_feature" }+ expect(test_feature.agent_setting).to eq("test_plugin_test_feature_agent")+ end+ end+enddiff --git a/plugins/discourse-ai/spec/configuration/module_register_spec.rb b/plugins/discourse-ai/spec/configuration/module_register_spec.rbnew file mode 100644index 00000000000..f96f27b8128--- /dev/null+++ b/plugins/discourse-ai/spec/configuration/module_register_spec.rb@@ -0,0 +1,99 @@+# frozen_string_literal: true++unless defined?(FakeExternalAgent)+ class FakeExternalAgent < DiscourseAi::Agents::Agent+ def tools+ []+ end++ def system_prompt+ "Test agent"+ end+ end+end++describe DiscourseAi::Configuration::Module do+ fab!(:fake_plugin) do+ plugin = Plugin::Instance.new+ plugin.path = "#{Rails.root}/spec/fixtures/plugins/my_plugin/plugin.rb"+ plugin+ end++ before do+ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_plugin,+ feature: :test_feature,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: nil,+ },+ fake_plugin,+ )+ end++ after do+ DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|+ entry[:value][:module_name] == :test_plugin+ end+ end++ describe ".all with filtered registry" do+ it "includes modules registered via the external AI features registry" do+ all_modules = described_class.all+ test_mod = all_modules.find { |m| m.name == :test_plugin }+ expect(test_mod).to be_present+ expect(test_mod.features.map(&:name)).to include("test_feature")+ end++ it "assigns a stable module ID from the module name" do+ all_modules = described_class.all+ test_mod = all_modules.find { |m| m.name == :test_plugin }+ expected_id = described_class.external_module_id(:test_plugin)+ expect(test_mod.id).to eq(expected_id)+ end++ context "with multiple features gated by different settings" do+ before do+ DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|+ entry[:value][:module_name] == :test_plugin+ end++ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_plugin,+ feature: :feature_a,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: "data_explorer_enabled",+ },+ fake_plugin,+ )++ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_plugin,+ feature: :feature_b,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: "data_explorer_ai_queries_enabled",+ },+ fake_plugin,+ )+ end++ it "is enabled when at least one feature is enabled" do+ SiteSetting.data_explorer_enabled = true+ SiteSetting.data_explorer_ai_queries_enabled = false++ test_mod = described_class.all.find { |m| m.name == :test_plugin }+ expect(test_mod).to be_enabled+ end++ it "is disabled when all features are disabled" do+ SiteSetting.data_explorer_enabled = false+ SiteSetting.data_explorer_ai_queries_enabled = false++ test_mod = described_class.all.find { |m| m.name == :test_plugin }+ expect(test_mod).not_to be_enabled+ end+ end+ end+enddiff --git a/plugins/discourse-ai/spec/lib/agents/agent_spec.rb b/plugins/discourse-ai/spec/lib/agents/agent_spec.rbindex 1af6ffbd337..0f9e00ee6a3 100644--- a/plugins/discourse-ai/spec/lib/agents/agent_spec.rb+++ b/plugins/discourse-ai/spec/lib/agents/agent_spec.rb@@ -1,5 +1,35 @@#frozen_string_literal: true+module FakeExternalPlugin+ class FakeExternalTool < DiscourseAi::Agents::Tools::Tool+ def self.signature+ { name: "fake_external_tool", description: "A fake tool", parameters: [] }+ end++ def self.custom?+ true+ end++ def self.name+ "fake_external_tool"+ end++ def invoke+ { result: "ok" }+ end+ end+end++class FakeExternalAgent < DiscourseAi::Agents::Agent+ def tools+ [FakeExternalPlugin::FakeExternalTool]+ end++ def system_prompt+ "Test agent"+ end+end+class TestAgent < DiscourseAi::Agents::Agentdef tools[@@ -253,7 +283,7 @@ RSpec.describe DiscourseAi::Agents::Agent do.map(&:superclass).reject { |klass| klass == DiscourseAi::Agents::Agent }- expect(system_agent_classes).to contain_exactly(+ expect(system_agent_classes).to include(DiscourseAi::Agents::General,DiscourseAi::Agents::SqlHelper,DiscourseAi::Agents::SettingsExplorer,@@ -285,6 +315,106 @@ RSpec.describe DiscourseAi::Agents::Agent doendend+ describe ".sync_external_registry!" do+ fab!(:fake_plugin) do+ plugin = Plugin::Instance.new+ plugin.path = "#{Rails.root}/spec/fixtures/plugins/my_plugin/plugin.rb"+ plugin+ end++ def register_fake_feature(module_name: :test_module, feature: :test_feature)+ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: module_name,+ feature: feature,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: nil,+ },+ fake_plugin,+ )+ end++ def reset_external_registry!+ described_class.instance_variable_set(:@external_registry_signature, nil)+ described_class.instance_variable_set(:@system_agents, nil)+ described_class.instance_variable_set(:@system_agents_by_id, nil)+ described_class.instance_variable_set(:@external_tools_by_name, nil)+ end++ after do+ DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|+ entry[:value][:module_name] == :test_module+ end+ reset_external_registry!+ end++ it "adds the external agent to system_agents" do+ register_fake_feature++ expected_id = described_class.external_agent_id(FakeExternalAgent)+ expect(described_class.system_agents[FakeExternalAgent]).to eq(expected_id)+ end++ it "makes the external agent discoverable by ID" do+ register_fake_feature++ expected_id = described_class.external_agent_id(FakeExternalAgent)+ expect(described_class.system_agents_by_id[expected_id]).to eq(FakeExternalAgent)+ end++ it "registers external tools for name-based lookup" do+ register_fake_feature++ expect(described_class.external_tool_by_name("FakeExternalTool")).to eq(+ FakeExternalPlugin::FakeExternalTool,+ )+ end++ it "includes external tools in the agent's available_tools" do+ register_fake_feature++ instance = FakeExternalAgent.new+ tool_names = instance.available_tools.map { |t| t.signature[:name] }+ expect(tool_names).to include("fake_external_tool")+ end++ it "produces one agent entry when two features share the same agent_klass" do+ register_fake_feature(feature: :feature_one)+ register_fake_feature(feature: :feature_two)++ matching = described_class.system_agents.select { |klass, _| klass == FakeExternalAgent }+ expect(matching.size).to eq(1)+ end++ it "does not overwrite a builtin agent when registered as an external agent_klass" do+ builtin_id = described_class.system_agents[DiscourseAi::Agents::SqlHelper]++ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_module,+ feature: :sql_feature,+ agent_klass: DiscourseAi::Agents::SqlHelper,+ enabled_by_setting: nil,+ },+ fake_plugin,+ )+ reset_external_registry!++ expect(described_class.system_agents[DiscourseAi::Agents::SqlHelper]).to eq(builtin_id)+ end++ it "keeps the external agent in system_agents even when the plugin is disabled" do+ register_fake_feature++ expect(described_class.system_agents).to have_key(FakeExternalAgent)++ fake_plugin.stubs(:enabled?).returns(false)+ reset_external_registry!++ expect(described_class.system_agents).to have_key(FakeExternalAgent)+ end+ end+describe "#craft_prompt" dofab!(:vector_def, :embedding_definition)diff --git a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rbindex c0c18c9977f..cdf03c151a2 100644--- a/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb+++ b/plugins/discourse-ai/spec/requests/admin/ai_agents_controller_spec.rb@@ -20,9 +20,19 @@ RSpec.describe DiscourseAi::Admin::AiAgentsController doexpect(response).to be_successfulexpect(response.parsed_body["ai_agents"].length).to eq(AiAgent.count)- expect(response.parsed_body["meta"]["tools"].length).to eq(- DiscourseAi::Agents::Agent.all_available_tools.length,- )++ expected_tool_count =+ DiscourseAi::Agents::Agent.all_available_tools.length ++ DiscourseAi::Agents::Agent.external_tools.length+ expect(response.parsed_body["meta"]["tools"].length).to eq(expected_tool_count)+ end++ it "includes external plugin tools in the tools list" do+ get "/admin/plugins/discourse-ai/ai-agents.json"+ tools = response.parsed_body["meta"]["tools"]+ tool_ids = tools.map { |t| t["id"] }+ expect(tool_ids).to include("ValidateSql")+ expect(tool_ids).to include("RunSql")endit "includes token_count for custom tools" dodiff --git a/plugins/discourse-ai/spec/requests/admin/ai_features_controller_spec.rb b/plugins/discourse-ai/spec/requests/admin/ai_features_controller_spec.rbindex 6a1a60fdd8d..fb68611559e 100644--- a/plugins/discourse-ai/spec/requests/admin/ai_features_controller_spec.rb+++ b/plugins/discourse-ai/spec/requests/admin/ai_features_controller_spec.rb@@ -20,7 +20,9 @@ RSpec.describe DiscourseAi::Admin::AiFeaturesController doget "/admin/plugins/discourse-ai/ai-features.json"expect(response.status).to eq(200)- expect(response.parsed_body["ai_features"].count).to eq(9)+ expect(response.parsed_body["ai_features"].count).to eq(+ DiscourseAi::Configuration::Module.all.size,+ )endit "includes automation-related features" do@@ -29,7 +31,9 @@ RSpec.describe DiscourseAi::Admin::AiFeaturesController doget "/admin/plugins/discourse-ai/ai-features.json"expect(response.status).to eq(200)- expect(response.parsed_body["ai_features"].count).to eq(11)+ expect(response.parsed_body["ai_features"].count).to eq(+ DiscourseAi::Configuration::Module.all.size,+ )endenddiff --git a/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb b/plugins/discourse-ai/spec/system/admin_ai_features_spec.rbindex 95068ee45c5..6bd1fbf755b 100644--- a/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb+++ b/plugins/discourse-ai/spec/system/admin_ai_features_spec.rb@@ -1,5 +1,17 @@# frozen_string_literal: true+unless defined?(FakeExternalAgent)+ class FakeExternalAgent < DiscourseAi::Agents::Agent+ def tools+ []+ end++ def system_prompt+ "Test agent"+ end+ end+end+RSpec.describe "Admin AI features configuration" dofab!(:admin)fab!(:llm_model)@@ -21,15 +33,17 @@ RSpec.describe "Admin AI features configuration" doendit "lists all agent backed AI features separated by configured/unconfigured" do+ all_modules = DiscourseAi::Configuration::Module.all+ configured_count = all_modules.count(&:enabled?)+ai_features_page.visitai_features_page.toggle_configured- expect(ai_features_page).to have_listed_modules(1)+ expect(ai_features_page).to have_listed_modules(configured_count)ai_features_page.toggle_unconfigured- # this changes as we add more AI features- expect(ai_features_page).to have_listed_modules(8)+ expect(ai_features_page).to have_listed_modules(all_modules.size - configured_count)endit "lists the agent used for the corresponding AI feature" do@@ -77,4 +91,36 @@ RSpec.describe "Admin AI features configuration" doexpect(field.component).to have_content("Test LLM Alpha")expect(field.component).to have_content("Test LLM Beta")end++ context "with external AI features" do+ let(:fake_plugin) do+ plugin = Plugin::Instance.new+ plugin.path = "#{Rails.root}/spec/fixtures/plugins/my_plugin/plugin.rb"+ plugin+ end++ before do+ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :test_external,+ feature: :test_feature,+ agent_klass: FakeExternalAgent,+ enabled_by_setting: nil,+ },+ fake_plugin,+ )+ end++ after do+ DiscoursePluginRegistry._raw_external_ai_features.reject! do |entry|+ entry[:value][:module_name] == :test_external+ end+ end++ it "shows external modules from the registry" do+ ai_features_page.visit+ expect(page).to have_content("test_external")+ expect(page).to have_content("test_feature")+ end+ endenddiff --git a/plugins/discourse-data-explorer/config/locales/client.en.yml b/plugins/discourse-data-explorer/config/locales/client.en.ymlindex dace49b86c6..6876f096c25 100644--- a/plugins/discourse-data-explorer/config/locales/client.en.yml+++ b/plugins/discourse-data-explorer/config/locales/client.en.yml@@ -1,5 +1,11 @@en:js:+ discourse_ai:+ features:+ data_explorer:+ name: "Data Explorer"+ description: "AI-powered query generation for Data Explorer"+ query_generation: "Query Generation"errors:explorer:no_semicolons: "Remove the semicolons from the query."diff --git a/plugins/discourse-data-explorer/config/locales/server.en.yml b/plugins/discourse-data-explorer/config/locales/server.en.ymlindex bf457988ca0..01013dc71ce 100644--- a/plugins/discourse-data-explorer/config/locales/server.en.yml+++ b/plugins/discourse-data-explorer/config/locales/server.en.yml@@ -1,6 +1,22 @@en:site_settings:data_explorer_enabled: "Enable data explorer"+ data_explorer_ai_queries_enabled: "Enable AI query generation in Data Explorer"+ discourse_ai:+ ai_bot:+ agents:+ ai_query_generator:+ name: "Data Explorer Query Generator"+ description: "Generates SQL queries for Data Explorer from natural language"+ tool_help:+ validate_sql: "Validates a SQL query for use in Data Explorer"+ run_sql: "Runs a SQL query and returns results"+ tool_summary:+ validate_sql: "Validating SQL query"+ run_sql: "Running SQL query"+ tool_description:+ validate_sql: "Validated SQL query"+ run_sql: "Ran SQL query"discourse_automation:scriptables:recurring_data_explorer_result_pm:diff --git a/plugins/discourse-data-explorer/config/settings.yml b/plugins/discourse-data-explorer/config/settings.ymlindex 74fa545732d..b987a2b9cd5 100644--- a/plugins/discourse-data-explorer/config/settings.yml+++ b/plugins/discourse-data-explorer/config/settings.yml@@ -2,6 +2,19 @@ plugins:data_explorer_enabled:default: falseclient: true+ data_explorer_ai_queries_enabled:+ default: false+ client: true+ depends_on:+ - discourse_ai_enabled+ depends_behavior: hidden+ data_explorer_query_generation_agent:+ default: "-1492485"+ type: enum+ enum: "DiscourseDataExplorer::AiAgentEnumerator"+ depends_on:+ - discourse_ai_enabled+ depends_behavior: hiddendata_explorer_query_result_limit:default: 1000hidden: truediff --git a/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rb b/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rbnew file mode 100644index 00000000000..033c69ecff1--- /dev/null+++ b/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_agent_enumerator.rb@@ -0,0 +1,18 @@+# frozen_string_literal: true++require "enum_site_setting"++module DiscourseDataExplorer+ class AiAgentEnumerator < ::EnumSiteSetting+ def self.valid_value?(val)+ true+ end++ def self.values+ return [] unless defined?(::AiAgent)+ ::AiAgent+ .all_agents(enabled_only: false)+ .map { |agent| { name: agent.name, value: agent.id } }+ end+ end+enddiff --git a/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_query_generator.rb b/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_query_generator.rbnew file mode 100644index 00000000000..e81182fcda5--- /dev/null+++ b/plugins/discourse-data-explorer/lib/discourse_data_explorer/ai_query_generator.rb@@ -0,0 +1,84 @@+# frozen_string_literal: true++module DiscourseDataExplorer+ class AiQueryGenerator < DiscourseAi::Agents::Agent+ def tools+ [+ DiscourseAi::Agents::Tools::DbSchema,+ DiscourseDataExplorer::Tools::ValidateSql,+ DiscourseDataExplorer::Tools::RunSql,+ ]+ end++ def temperature+ 0.2+ end++ def response_format+ [+ { "key" => "name", "type" => "string" },+ { "key" => "description", "type" => "string" },+ { "key" => "sql", "type" => "string" },+ ]+ end++ def system_prompt+ <<~PROMPT+ You are a PostgreSQL expert that generates queries for Discourse Data Explorer.++ Return a JSON response with three fields:+ - "name": a short descriptive name for the query (under 60 characters)+ - "description": a one-sentence description of what the query does+ - "sql": the SQL query++ SQL rules:+ - NEVER end SQL with a semicolon (;)+ - Format SQL for maximum readability with line breaks, indentation, and spaces around operators++ Data Explorer formatting rules:+ - Columns named (user_id, group_id, topic_id, post_id, badge_id) render as links, prefer them where possible+ - You can define custom params for flexible queries:+ -- [params]+ -- int :num = 1+ -- text :name++ SELECT :num, :name+ - Supported param types: integer, text, boolean, date++ Discourse schema knowledge:+ - user_actions table stores likes (action_type 1)+ - topics table stores private/personal messages using archetype 'private_message'+ - notification_level: {muted: 0, regular: 1, tracking: 2, watching: 3, watching_first_post: 4}+ - bookmarkable_type can be: Post, Topic, ChatMessage and more++ Current date is: {date}++ #{schema_context}+ PROMPT+ end++ private++ def schema_context+ schema = DiscourseAi::Agents::SqlHelper.schema++ <<~CONTEXT+ Here is a partial list of tables in the database (you can retrieve schema from these tables as needed)++ ```+ #{schema[:other_tables]}+ ```++ You may look up schema for the tables listed above.++ Here is full information on priority tables:++ ```+ #{schema[:priority_tables]}+ ```++ NEVER look up schema for the tables listed above, as their full schema is already provided.+ CONTEXT+ end+ end+enddiff --git a/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/run_sql.rb b/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/run_sql.rbnew file mode 100644index 00000000000..c3555178df6--- /dev/null+++ b/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/run_sql.rb@@ -0,0 +1,69 @@+# frozen_string_literal: true++module DiscourseDataExplorer+ module Tools+ class RunSql < DiscourseAi::Agents::Tools::Tool+ MAX_ROWS = 20+ MAX_CELL_LENGTH = 200++ def self.signature+ {+ name: name,+ description:+ "Runs a SQL query in Data Explorer and returns the results. Use this to verify a query produces correct output.",+ parameters: [+ {+ name: "sql",+ description: "the SQL query to run (without semicolons)",+ type: "string",+ required: true,+ },+ ],+ }+ end++ def self.custom?+ true+ end++ def self.name+ "run_sql"+ end++ def invoke+ sql = parameters[:sql].to_s.strip+ return error_response("SQL query is empty") if sql.blank?++ query = DiscourseDataExplorer::Query.new(name: "AI tool query", sql: sql)+ result = DiscourseDataExplorer::DataExplorer.run_query(query, {}, limit: MAX_ROWS + 1)++ return error_response(result[:error].message) if result[:error]++ pg_result = result[:pg_result]+ columns = pg_result.fields+ rows = pg_result.values+ total_rows = rows.length+ rows = rows.first(MAX_ROWS)++ rows =+ rows.map do |row|+ row.map do |cell|+ if cell.is_a?(String) && cell.length > MAX_CELL_LENGTH+ "#{cell[0...MAX_CELL_LENGTH]}..."+ else+ cell+ end+ end+ end++ { status: "success", columns: columns, rows: rows, row_count: total_rows }+ end++ protected++ def description_args+ { sql: parameters[:sql].to_s.truncate(100) }+ end+ end+ end+enddiff --git a/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/validate_sql.rb b/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/validate_sql.rbnew file mode 100644index 00000000000..01e7b842400--- /dev/null+++ b/plugins/discourse-data-explorer/lib/discourse_data_explorer/tools/validate_sql.rb@@ -0,0 +1,50 @@+# frozen_string_literal: true++module DiscourseDataExplorer+ module Tools+ class ValidateSql < DiscourseAi::Agents::Tools::Tool+ def self.signature+ {+ name: name,+ description:+ "Validates a SQL query for use in Data Explorer. Checks for prohibited syntax and verifies the query is valid PostgreSQL.",+ parameters: [+ {+ name: "sql",+ description: "the SQL query to validate (without semicolons)",+ type: "string",+ required: true,+ },+ ],+ }+ end++ def self.custom?+ true+ end++ def self.name+ "validate_sql"+ end++ def invoke+ sql = parameters[:sql].to_s.strip++ return error_response("SQL query is empty") if sql.blank?++ query = DiscourseDataExplorer::Query.new(name: "AI tool validation", sql: sql)+ result = DiscourseDataExplorer::DataExplorer.run_query(query, {}, limit: 0)++ return error_response(result[:error].message) if result[:error]++ { status: "valid" }+ end++ protected++ def description_args+ { sql: parameters[:sql].to_s.truncate(100) }+ end+ end+ end+enddiff --git a/plugins/discourse-data-explorer/plugin.rb b/plugins/discourse-data-explorer/plugin.rbindex 3b395e09bc0..00a73a2490f 100644--- a/plugins/discourse-data-explorer/plugin.rb+++ b/plugins/discourse-data-explorer/plugin.rb@@ -9,6 +9,8 @@enabled_site_setting :data_explorer_enabled+register_site_setting_area("ai-features/data_explorer") if defined?(DiscourseAi)+register_asset "stylesheets/explorer.scss"register_svg_icon "angle-down"@@ -195,4 +197,23 @@ after_initialize doendendend++ if defined?(DiscourseAi)+ require_relative "lib/discourse_data_explorer/tools/validate_sql"+ require_relative "lib/discourse_data_explorer/tools/run_sql"+ require_relative "lib/discourse_data_explorer/ai_query_generator"++ DiscoursePluginRegistry.register_external_ai_feature(+ {+ module_name: :data_explorer,+ feature: :query_generation,+ agent_klass: DiscourseDataExplorer::AiQueryGenerator,+ enabled_by_setting: "data_explorer_ai_queries_enabled",+ },+ self,+ )++ SiteSetting.areas[:data_explorer_ai_queries_enabled] ||= "ai-features/data_explorer"+ SiteSetting.areas[:data_explorer_query_generation_agent] ||= "ai-features/data_explorer"+ endend