feat: captain custom tools v1 (#13890)
# Pull Request Template ## Description Adds custom tool support to v1 ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. <img width="1816" height="958" alt="CleanShot 2026-03-24 at 11 37 33@2x" src="https://github.com/user-attachments/assets/2777a953-8b65-4a2d-88ec-39f395b3fb47" /> <img width="378" height="488" alt="CleanShot 2026-03-24 at 11 38 18@2x" src="https://github.com/user-attachments/assets/f6973c99-efd0-40e4-90fe-4472a2f63cea" /> <img width="1884" height="1452" alt="CleanShot 2026-03-24 at 11 38 32@2x" src="https://github.com/user-attachments/assets/9fba4fc4-0c33-46da-888a-52ec6bad6130" /> ## Checklist: - [x] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com>
This commit is contained in:
@@ -1,16 +1,19 @@
|
||||
class Api::V1::Accounts::Captain::CustomToolsController < Api::V1::Accounts::BaseController
|
||||
before_action :current_account
|
||||
before_action :ensure_custom_tools_enabled
|
||||
before_action -> { check_authorization(Captain::CustomTool) }
|
||||
before_action :set_custom_tool, only: [:show, :update, :destroy]
|
||||
|
||||
def index
|
||||
@custom_tools = account_custom_tools.enabled
|
||||
@custom_tools = account_custom_tools
|
||||
end
|
||||
|
||||
def show; end
|
||||
|
||||
def create
|
||||
@custom_tool = account_custom_tools.create!(custom_tool_params)
|
||||
rescue Captain::CustomTool::LimitExceededError => e
|
||||
render_could_not_create_error(e.message)
|
||||
end
|
||||
|
||||
def update
|
||||
@@ -22,8 +25,22 @@ class Api::V1::Accounts::Captain::CustomToolsController < Api::V1::Accounts::Bas
|
||||
head :no_content
|
||||
end
|
||||
|
||||
def test
|
||||
tool = account_custom_tools.new(custom_tool_params)
|
||||
result = execute_test_request(tool)
|
||||
render json: { status: result.code.to_i, body: result.body.to_s.truncate(500) }
|
||||
rescue StandardError => e
|
||||
render json: { error: e.message }, status: :unprocessable_content
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def ensure_custom_tools_enabled
|
||||
return if Current.account.feature_enabled?('custom_tools') || Current.account.feature_enabled?('captain_integration_v2')
|
||||
|
||||
render json: { error: 'Custom tools are not enabled for this account' }, status: :forbidden
|
||||
end
|
||||
|
||||
def set_custom_tool
|
||||
@custom_tool = account_custom_tools.find(params[:id])
|
||||
end
|
||||
@@ -32,6 +49,11 @@ class Api::V1::Accounts::Captain::CustomToolsController < Api::V1::Accounts::Bas
|
||||
@account_custom_tools ||= Current.account.captain_custom_tools
|
||||
end
|
||||
|
||||
def execute_test_request(tool)
|
||||
http_tool = Captain::Tools::HttpTool.new(nil, tool)
|
||||
http_tool.send(:execute_http_request, tool.endpoint_url, nil, nil)
|
||||
end
|
||||
|
||||
def custom_tool_params
|
||||
params.require(:custom_tool).permit(
|
||||
:title,
|
||||
|
||||
@@ -24,6 +24,10 @@
|
||||
# index_captain_custom_tools_on_account_id_and_slug (account_id,slug) UNIQUE
|
||||
#
|
||||
class Captain::CustomTool < ApplicationRecord
|
||||
class LimitExceededError < StandardError; end
|
||||
|
||||
MAX_PER_ACCOUNT = 15
|
||||
|
||||
include Concerns::Toolable
|
||||
include Concerns::SafeEndpointValidatable
|
||||
|
||||
@@ -31,6 +35,10 @@ class Captain::CustomTool < ApplicationRecord
|
||||
|
||||
NAME_PREFIX = 'custom'.freeze
|
||||
NAME_SEPARATOR = '_'.freeze
|
||||
# OpenAI enforces a 64-char limit on function names. The slug is used
|
||||
# verbatim as the tool name in LLM requests, so it must fit within this limit.
|
||||
MAX_SLUG_LENGTH = 64
|
||||
COLLISION_SUFFIX_LENGTH = 7 # "_" + 6 random alphanumeric chars
|
||||
PARAM_SCHEMA_VALIDATION = {
|
||||
'type': 'array',
|
||||
'items': {
|
||||
@@ -52,8 +60,9 @@ class Captain::CustomTool < ApplicationRecord
|
||||
enum :auth_type, %w[none bearer basic api_key].index_by(&:itself), default: :none, validate: true, prefix: :auth
|
||||
|
||||
before_validation :generate_slug
|
||||
before_create :ensure_within_limit
|
||||
|
||||
validates :slug, presence: true, uniqueness: { scope: :account_id }
|
||||
validates :slug, presence: true, uniqueness: { scope: :account_id }, length: { maximum: MAX_SLUG_LENGTH }
|
||||
validates :title, presence: true
|
||||
validates :endpoint_url, presence: true
|
||||
validates_with JsonSchemaValidator,
|
||||
@@ -73,21 +82,29 @@ class Captain::CustomTool < ApplicationRecord
|
||||
|
||||
private
|
||||
|
||||
def ensure_within_limit
|
||||
# Lock the account row to serialize concurrent creates and prevent exceeding the cap
|
||||
Account.lock.find(account_id)
|
||||
return if account.captain_custom_tools.count < MAX_PER_ACCOUNT
|
||||
|
||||
raise LimitExceededError, I18n.t('captain.custom_tool.limit_exceeded', limit: MAX_PER_ACCOUNT)
|
||||
end
|
||||
|
||||
def generate_slug
|
||||
return if slug.present?
|
||||
return if title.blank?
|
||||
|
||||
paramterized_title = title.parameterize(separator: NAME_SEPARATOR)
|
||||
|
||||
base_slug = "#{NAME_PREFIX}#{NAME_SEPARATOR}#{paramterized_title}"
|
||||
parameterized_title = title.parameterize(separator: NAME_SEPARATOR)
|
||||
base_slug = "#{NAME_PREFIX}#{NAME_SEPARATOR}#{parameterized_title}".truncate(MAX_SLUG_LENGTH, omission: '')
|
||||
self.slug = find_unique_slug(base_slug)
|
||||
end
|
||||
|
||||
def find_unique_slug(base_slug)
|
||||
return base_slug unless slug_exists?(base_slug)
|
||||
|
||||
truncated = base_slug.truncate(MAX_SLUG_LENGTH - COLLISION_SUFFIX_LENGTH, omission: '')
|
||||
5.times do
|
||||
slug_candidate = "#{base_slug}#{NAME_SEPARATOR}#{SecureRandom.alphanumeric(6).downcase}"
|
||||
slug_candidate = "#{truncated}#{NAME_SEPARATOR}#{SecureRandom.alphanumeric(6).downcase}"
|
||||
return slug_candidate unless slug_exists?(slug_candidate)
|
||||
end
|
||||
|
||||
|
||||
@@ -1,15 +1,23 @@
|
||||
module Concerns::Toolable
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def tool(assistant)
|
||||
# Isolated namespace for user-defined custom tool classes.
|
||||
# Keeps them separate from built-in classes in Captain::Tools (e.g., HttpTool, CustomHttpTool).
|
||||
module CustomTools; end
|
||||
|
||||
def tool(assistant, base_class: Captain::Tools::HttpTool, **)
|
||||
custom_tool_record = self
|
||||
# Convert slug to valid Ruby constant name (replace hyphens with underscores, then camelize)
|
||||
class_name = custom_tool_record.slug.underscore.camelize
|
||||
|
||||
# Always create a fresh class to reflect current metadata
|
||||
tool_class = Class.new(Captain::Tools::HttpTool) do
|
||||
tool_slug = custom_tool_record.slug
|
||||
tool_class = Class.new(base_class) do
|
||||
description custom_tool_record.description
|
||||
|
||||
# Override name to use the slug directly, avoiding the namespace prefix
|
||||
# that RubyLLM's default normalization would produce (e.g., "captain--tools--custom_dog_facts").
|
||||
define_method(:name) { tool_slug }
|
||||
|
||||
custom_tool_record.param_schema.each do |param_def|
|
||||
param param_def['name'].to_sym,
|
||||
type: param_def['type'],
|
||||
@@ -18,17 +26,14 @@ module Concerns::Toolable
|
||||
end
|
||||
end
|
||||
|
||||
# Register the dynamically created class as a constant in the Captain::Tools namespace.
|
||||
# This is required because RubyLLM's Tool base class derives the tool name from the class name
|
||||
# (via Class#name). Anonymous classes created with Class.new have no name and return empty strings,
|
||||
# which causes "Invalid 'tools[].function.name': empty string" errors from the LLM API.
|
||||
# By setting it as a constant, the class gets a proper name (e.g., "Captain::Tools::CatFactLookup")
|
||||
# which RubyLLM extracts and normalizes to "cat-fact-lookup" for the LLM API.
|
||||
# We refresh the constant on each call to ensure tool metadata changes are reflected.
|
||||
Captain::Tools.send(:remove_const, class_name) if Captain::Tools.const_defined?(class_name, false)
|
||||
Captain::Tools.const_set(class_name, tool_class)
|
||||
# Register as a constant so the class gets a proper name (Class#name).
|
||||
# Anonymous classes return nil for #name, which causes "Invalid 'tools[].function.name':
|
||||
# empty string" errors from the LLM API. We use CustomTools as the namespace to avoid
|
||||
# collisions with real classes in Captain::Tools.
|
||||
CustomTools.send(:remove_const, class_name) if CustomTools.const_defined?(class_name, false)
|
||||
CustomTools.const_set(class_name, tool_class)
|
||||
|
||||
tool_class.new(assistant, self)
|
||||
tool_class.new(assistant, self, **)
|
||||
end
|
||||
|
||||
def build_request_url(params)
|
||||
|
||||
@@ -11,6 +11,10 @@ class Captain::CustomToolPolicy < ApplicationPolicy
|
||||
@account_user.administrator?
|
||||
end
|
||||
|
||||
def test?
|
||||
@account_user.administrator?
|
||||
end
|
||||
|
||||
def update?
|
||||
@account_user.administrator?
|
||||
end
|
||||
|
||||
@@ -30,7 +30,12 @@ class Captain::Llm::AssistantChatService < Llm::BaseAiService
|
||||
private
|
||||
|
||||
def build_tools
|
||||
[Captain::Tools::SearchDocumentationService.new(@assistant, user: nil)]
|
||||
tools = [Captain::Tools::SearchDocumentationService.new(@assistant, user: nil)]
|
||||
return tools unless custom_tools_enabled?
|
||||
|
||||
tools + @assistant.account.captain_custom_tools.enabled.map do |ct|
|
||||
ct.tool(@assistant, base_class: Captain::Tools::CustomHttpTool, conversation: @conversation)
|
||||
end
|
||||
end
|
||||
|
||||
def system_message
|
||||
@@ -38,11 +43,24 @@ class Captain::Llm::AssistantChatService < Llm::BaseAiService
|
||||
role: 'system',
|
||||
content: Captain::Llm::SystemPromptsService.assistant_response_generator(
|
||||
@assistant.name, @assistant.config['product_name'], @assistant.config,
|
||||
contact: contact_attributes
|
||||
contact: contact_attributes,
|
||||
custom_tools: custom_tools_metadata
|
||||
)
|
||||
}
|
||||
end
|
||||
|
||||
def custom_tools_metadata
|
||||
return [] unless custom_tools_enabled?
|
||||
|
||||
@assistant.account.captain_custom_tools.enabled.map do |ct|
|
||||
{ name: ct.slug, description: ct.description }
|
||||
end
|
||||
end
|
||||
|
||||
def custom_tools_enabled?
|
||||
@assistant.account.feature_enabled?('custom_tools')
|
||||
end
|
||||
|
||||
def contact_attributes
|
||||
return nil unless @conversation&.contact
|
||||
return nil unless @assistant&.feature_contact_attributes
|
||||
|
||||
@@ -152,7 +152,7 @@ class Captain::Llm::SystemPromptsService
|
||||
# rubocop:enable Metrics/MethodLength
|
||||
|
||||
# rubocop:disable Metrics/MethodLength
|
||||
def assistant_response_generator(assistant_name, product_name, config = {}, contact: nil)
|
||||
def assistant_response_generator(assistant_name, product_name, config = {}, contact: nil, custom_tools: [])
|
||||
assistant_citation_guidelines = if config['feature_citation']
|
||||
<<~CITATION_TEXT
|
||||
- Always include citations for any information provided, referencing the specific source (document only - skip if it was derived from a conversation).
|
||||
@@ -187,7 +187,7 @@ class Captain::Llm::SystemPromptsService
|
||||
#{assistant_citation_guidelines}
|
||||
|
||||
#{build_contact_context(contact)}[Task]
|
||||
Start by introducing yourself. Then, ask the user to share their question. When they answer, call the search_documentation function. Give a helpful response based on the steps written below.
|
||||
Start by introducing yourself. Then, ask the user to share their question. When they answer, use the most appropriate tool to find information. Give a helpful response based on the steps written below.
|
||||
|
||||
- Provide the user with the steps required to complete the action one by one.
|
||||
- Do not return list numbers in the steps, just the plain text is enough.
|
||||
@@ -203,6 +203,8 @@ class Captain::Llm::SystemPromptsService
|
||||
```
|
||||
- If the answer is not provided in context sections, Respond to the customer and ask whether they want to talk to another support agent . If they ask to Chat with another agent, return `conversation_handoff' as the response in JSON response
|
||||
#{'- You MUST provide numbered citations at the appropriate places in the text.' if config['feature_citation']}
|
||||
|
||||
#{build_tools_section(custom_tools)}
|
||||
SYSTEM_PROMPT_MESSAGE
|
||||
end
|
||||
|
||||
@@ -291,6 +293,15 @@ class Captain::Llm::SystemPromptsService
|
||||
|
||||
private
|
||||
|
||||
def build_tools_section(custom_tools)
|
||||
tools_list = custom_tools.map { |t| "- #{t[:name]}: #{t[:description]}" }.join("\n")
|
||||
<<~TOOLS.strip
|
||||
[Available Tools]
|
||||
- search_documentation: Search and retrieve documentation from knowledge base
|
||||
#{tools_list}
|
||||
TOOLS
|
||||
end
|
||||
|
||||
def build_contact_context(contact)
|
||||
return '' if contact.nil?
|
||||
|
||||
|
||||
47
enterprise/app/services/captain/tools/custom_http_tool.rb
Normal file
47
enterprise/app/services/captain/tools/custom_http_tool.rb
Normal file
@@ -0,0 +1,47 @@
|
||||
# V1-compatible wrapper for custom HTTP tools.
|
||||
#
|
||||
# V2's HttpTool inherits from Agents::Tool which overrides execute(tool_context, **params),
|
||||
# making it incompatible with V1's RubyLLM pipeline that calls execute(**keyword_args).
|
||||
#
|
||||
# This class bridges the gap: it inherits from BaseTool (RubyLLM::Tool) for V1 compatibility
|
||||
# and delegates the actual HTTP execution to HttpTool#perform.
|
||||
class Captain::Tools::CustomHttpTool < Captain::Tools::BaseTool
|
||||
# BaseTool prepends Instrumentation, but our execute() shadows it in the MRO.
|
||||
# Re-prepend so Langfuse captures tool call input/output/timing.
|
||||
prepend Captain::Tools::Instrumentation
|
||||
|
||||
attr_reader :custom_tool
|
||||
|
||||
def initialize(assistant, custom_tool, conversation: nil)
|
||||
@custom_tool = custom_tool
|
||||
@conversation = conversation
|
||||
super(assistant)
|
||||
end
|
||||
|
||||
def active?
|
||||
@custom_tool.enabled?
|
||||
end
|
||||
|
||||
def execute(**params)
|
||||
http_tool = Captain::Tools::HttpTool.new(assistant, @custom_tool)
|
||||
http_tool.perform(build_tool_context, **params)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def build_tool_context
|
||||
state = { account_id: assistant.account_id, assistant_id: assistant.id }
|
||||
add_conversation_state(state) if @conversation
|
||||
OpenStruct.new(state: state)
|
||||
end
|
||||
|
||||
def add_conversation_state(state)
|
||||
state[:conversation] = { id: @conversation.id, display_id: @conversation.display_id }
|
||||
state[:contact] = slice_record_attrs(@conversation.contact, :id, :email, :phone_number)
|
||||
state[:contact_inbox] = slice_record_attrs(@conversation.contact_inbox, :id, :hmac_verified)
|
||||
end
|
||||
|
||||
def slice_record_attrs(record, *keys)
|
||||
record&.attributes&.symbolize_keys&.slice(*keys)
|
||||
end
|
||||
end
|
||||
@@ -17,7 +17,7 @@ class Enterprise::Billing::ReconcilePlanFeaturesService
|
||||
linear_integration
|
||||
].freeze
|
||||
|
||||
BUSINESS_PLAN_FEATURES = %w[sla custom_roles csat_review_notes conversation_required_attributes advanced_assignment].freeze
|
||||
BUSINESS_PLAN_FEATURES = %w[sla custom_roles csat_review_notes conversation_required_attributes advanced_assignment custom_tools].freeze
|
||||
ENTERPRISE_PLAN_FEATURES = %w[audit_logs disable_branding saml].freeze
|
||||
PREMIUM_PLAN_FEATURES = (STARTUP_PLAN_FEATURES + BUSINESS_PLAN_FEATURES + ENTERPRISE_PLAN_FEATURES).freeze
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ json.http_method custom_tool.http_method
|
||||
json.request_template custom_tool.request_template
|
||||
json.response_template custom_tool.response_template
|
||||
json.auth_type custom_tool.auth_type
|
||||
json.auth_config custom_tool.auth_config
|
||||
json.auth_config custom_tool.auth_config if Current.user&.administrator?
|
||||
json.param_schema custom_tool.param_schema
|
||||
json.enabled custom_tool.enabled
|
||||
json.account_id custom_tool.account_id
|
||||
|
||||
Reference in New Issue
Block a user