Module: AgentHarness::Providers::Adapter

Included in:
Base
Defined in:
lib/agent_harness/providers/adapter.rb

Overview

Interface that all providers must implement

This module defines the contract that provider implementations must follow. Include this module in provider classes to ensure they implement the required interface.

Examples:

Implementing a provider

class MyProvider < AgentHarness::Providers::Base
  include AgentHarness::Providers::Adapter

  def self.provider_name
    :my_provider
  end
end

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



75
76
77
 
# File 'lib/agent_harness/providers/adapter.rb', line 75

def self.included(base)
  base.extend(ClassMethods)
end

.metadata_package_name(contract, source) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/agent_harness/providers/adapter.rb', line 46

def self.metadata_package_name(contract, source)
  return contract[:package_name] if contract[:package_name]
  return source[:package] if source.is_a?(Hash)

  package = contract[:package]
  return package unless package.is_a?(String)

  if package.split("@").first == ""
    package.split("@", 3).first(2).join("@")
  else
    package.split("@", 2).first
  end
end

.normalize_metadata_installation(contract, provider_name:, binary_name:) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/agent_harness/providers/adapter.rb', line 19

def self.normalize_metadata_installation(contract, provider_name:, binary_name:)
  return nil unless contract.is_a?(Hash)

  source = contract[:source]
  install_command = contract[:install_command]&.dup

  {
    provider: provider_name.to_sym,
    source_type: normalize_metadata_source_type(contract[:source_type] || source),
    package_name: metadata_package_name(contract, source),
    default_version: contract[:default_version] || contract[:version] || contract[:resolved_version],
    resolved_version: contract[:resolved_version] || contract[:version] || contract[:default_version],
    supported_version_requirement: normalize_metadata_version_requirement(
      contract[:supported_version_requirement] || contract[:version_requirement]
    ),
    binary_name: contract[:binary_name] || binary_name,
    install_command: install_command,
    install_command_string: contract[:install_command_string] || install_command&.join(" ")
  }
end

.normalize_metadata_source_type(source) ⇒ Object 



40
41
42
43
44
 
# File 'lib/agent_harness/providers/adapter.rb', line 40

def self.normalize_metadata_source_type(source)
  return source[:type]&.to_sym if source.is_a?(Hash)

  source&.to_sym
end

.normalize_metadata_version_requirement(requirement) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/agent_harness/providers/adapter.rb', line 60

def self.normalize_metadata_version_requirement(requirement)
  case requirement
  when nil
    nil
  when Array
    if requirement.all? { |entry| entry.is_a?(Array) && entry.length == 2 }
      requirement.map { |operator, version| "#{operator} #{version}" }.join(", ")
    else
      requirement.join(", ")
    end
  else
    requirement.to_s
  end
end

Instance Method Details

#auth_lock_config ⇒ Hash?

Auth lock configuration for providers that need file-based lock serialization (e.g. OAuth refresh token coordination).

Returns:

  • (Hash, nil) —

    lock config with :path and :timeout keys, or nil



1195
1196
1197
 
# File 'lib/agent_harness/providers/adapter.rb', line 1195

def auth_lock_config
  nil
end

#auth_type ⇒ Symbol

Authentication type for this provider

Returns:

  • (Symbol) —

    :oauth for token-based auth that can expire, :api_key for static API key auth



873
874
875
 
# File 'lib/agent_harness/providers/adapter.rb', line 873

def auth_type
  :api_key
end

#build_mcp_flags(mcp_servers, working_dir: nil) ⇒ Array<String>

Build provider-specific MCP flags/arguments for CLI invocation

Parameters:

  • mcp_servers (Array<McpServer>) —

    MCP server definitions

  • working_dir (String, nil) (defaults to: nil) —

    working directory for temp files

Returns:

  • (Array<String>) —

    CLI flags to append to the command



906
907
908
 
# File 'lib/agent_harness/providers/adapter.rb', line 906

def build_mcp_flags(mcp_servers, working_dir: nil)
  []
end

#capabilities ⇒ Hash

Provider capabilities

Returns:

  • (Hash) —

    capability flags



806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/agent_harness/providers/adapter.rb', line 806

def capabilities
  {
    streaming: false,
    file_upload: false,
    vision: false,
    tool_use: false,
    json_mode: false,
    mcp: false,
    dangerous_mode: false
  }
end

#chat_transport ⇒ Object?

Returns the transport instance used for chat mode.

Providers that support chat override this to return an appropriate transport (e.g. OpenAICompatibleTransport or TextTransport).

Returns:

  • (Object, nil) —

    transport instance or nil if unsupported



989
990
991
 
# File 'lib/agent_harness/providers/adapter.rb', line 989

def chat_transport
  nil
end

#chat_transport_type ⇒ Symbol?

Returns the symbolic transport type for chat without instantiating the transport object. This avoids triggering API key resolution or other authentication side effects during metadata collection.

Returns:

  • (Symbol, nil) —

    :openai_compatible, :anthropic, or nil



998
999
1000
 
# File 'lib/agent_harness/providers/adapter.rb', line 998

def chat_transport_type
  nil
end

#config_file_content(options = {}) ⇒ String?

Generate provider-specific config file content.

Providers that require a config file written before CLI execution (e.g. Codex TOML, Kilocode JSON) should override this method.

Parameters:

  • options (Hash) (defaults to: {}) —

    provider-specific options for config generation

Returns:

  • (String, nil) —

    config file content, or nil when no config is needed



1177
1178
1179
 
# File 'lib/agent_harness/providers/adapter.rb', line 1177

def config_file_content(options = {})
  nil
end

#configuration_schema ⇒ Hash

Provider configuration schema for app-driven setup UIs

Returns metadata describing the configurable fields, supported authentication modes, and backend compatibility for this provider. Applications use this to build generic provider-entry forms without hardcoding provider-specific knowledge.

Returns:

  • (Hash) —

    with :fields, :auth_modes, :openai_compatible keys



795
796
797
798
799
800
801
 
# File 'lib/agent_harness/providers/adapter.rb', line 795

def configuration_schema
  {
    fields: [],
    auth_modes: [auth_type],
    openai_compatible: false
  }
end

#dangerous_mode_flags ⇒ Array<String>

Get dangerous mode flags

Returns:

  • (Array<String>) —

    CLI flags for dangerous mode



1012
1013
1014
 
# File 'lib/agent_harness/providers/adapter.rb', line 1012

def dangerous_mode_flags
  []
end

#error_classification_patterns ⇒ Hash<Symbol, Array<Regexp>>

Error classification patterns for downstream consumers

Returns patterns grouped by classification category. These patterns encode provider-specific knowledge about how each CLI reports errors and are intended for use by callers outside agent-harness.

Returns:

  • (Hash<Symbol, Array<Regexp>>) —

    patterns by category (:auth_expired, :abort, :authentication, :quota)



833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/agent_harness/providers/adapter.rb', line 833

def error_classification_patterns
  {
    auth_expired: [],
    abort: [],
    authentication: [],
    quota: [
      /requires more credits/i,
      /insufficient credits/i,
      /credit.*exceeded/i,
      /spend limit.*reached/i,
      /billing.*limit/i
    ]
  }
end

#error_patterns ⇒ Hash<Symbol, Array<Regexp>>

Error patterns for classification

Returns:

  • (Hash<Symbol, Array<Regexp>>) —

    error patterns by category



821
822
823
 
# File 'lib/agent_harness/providers/adapter.rb', line 821

def error_patterns
  {}
end

#execution_semantics ⇒ Hash

Execution semantics for this provider

Returns a hash describing provider-specific execution behavior so downstream apps do not need to hardcode CLI quirks. This metadata can be used to select the right flags and interpret output.

Returns:

  • (Hash) —

    execution semantics



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/agent_harness/providers/adapter.rb', line 1145

def execution_semantics
  {
    prompt_delivery: :arg,       # :arg, :stdin, or :flag
    output_format: :text,        # :text or :json
    sandbox_aware: false,        # adjusts behavior inside containers
    uses_subcommand: false,      # e.g. "codex exec", "opencode run"
    non_interactive_flag: nil,   # flag to suppress interactive prompts
    legitimate_exit_codes: [0],  # exit codes that are NOT errors
    stderr_is_diagnostic: true,  # stderr may contain non-error output
    parses_rate_limit_reset: false # can extract Retry-After from output
  }
end

#fetch_mcp_servers ⇒ Array<Hash>

Fetch configured MCP servers

Returns:

  • (Array<Hash>) —

    MCP server configurations



887
888
889
 
# File 'lib/agent_harness/providers/adapter.rb', line 887

def fetch_mcp_servers
  []
end

#health_status ⇒ Hash

Health check

Returns:

  • (Hash) —

    with :healthy, :message keys



1059
1060
1061
 
# File 'lib/agent_harness/providers/adapter.rb', line 1059

def health_status
  {healthy: true, message: "OK"}
end

#heartbeat_integration(heartbeat_file_path:) ⇒ Hash

Return structured heartbeat integration wiring for this provider.

Providers that support activity heartbeat return a Hash describing how to wire heartbeat file touches into the CLI execution. The returned contract includes environment variables, execution preparation (config/plugin file writes), and the heartbeat granularity so downstream callers can enable heartbeat-backed idle timeout without hardcoding provider-specific config logic.

Parameters:

  • heartbeat_file_path (String) —

    absolute path to the heartbeat file that should be touched on activity

Returns:

  • (Hash) —

    heartbeat integration contract:

    • :supported [Boolean] whether heartbeat is available

    • :env [Hash] environment variables to set (empty when unsupported)

    • :preparation [ExecutionPreparation, nil] file writes for config/plugin wiring

    • :granularity [Symbol, nil] heartbeat event granularity (:tool_call, :turn, or :progress)



1228
1229
1230
 
# File 'lib/agent_harness/providers/adapter.rb', line 1228

def heartbeat_integration(heartbeat_file_path:)
  {supported: false, env: {}, preparation: nil, granularity: nil}
end

#noisy_error_patterns ⇒ Array<Regexp>

Patterns matching noisy/non-actionable error output

Downstream consumers can use these to filter out log noise from provider stderr/stdout that is not meaningful for users.

Returns:

  • (Array<Regexp>) —

    noisy error patterns



854
855
856
 
# File 'lib/agent_harness/providers/adapter.rb', line 854

def noisy_error_patterns
  []
end

#notify_hook_content ⇒ String?

Generate provider-specific notification hook content.

Providers that support notification hooks appended to their config file should override this method.

Returns:

  • (String, nil) —

    notify hook content, or nil when not applicable



1187
1188
1189
 
# File 'lib/agent_harness/providers/adapter.rb', line 1187

def notify_hook_content
  nil
end

#parse_rate_limit_reset(output) ⇒ Time?

Parse a rate-limit reset time from provider output

Providers that include rate-limit reset information in their error output can override this to extract it, so the orchestration layer can schedule retries accurately.

Parameters:

  • output (String) —

    combined stdout+stderr from the CLI

Returns:

  • (Time, nil) —

    when the rate limit resets, or nil if unknown



1166
1167
1168
 
# File 'lib/agent_harness/providers/adapter.rb', line 1166

def parse_rate_limit_reset(output)
  nil
end

#plan_execution(prompt:, **options) ⇒ Hash

Return the provider CLI execution plan without executing the command.

Parameters:

  • prompt (String) —

    the prompt to send

  • options (Hash) —

    provider-specific options

Returns:

  • (Hash) —

    with :command, :env, and :preparation keys

Raises:

  • (NotImplementedError) 


783
784
785
 
# File 'lib/agent_harness/providers/adapter.rb', line 783

def plan_execution(prompt:, **options)
  raise NotImplementedError, "#{self.class} must implement #plan_execution"
end

#preflight_check(env:, timeout: 10) ⇒ Hash

Lightweight provider-owned preflight check executed before smoke tests.

Parameters:

  • env (Hash) —

    request-scoped environment overrides

  • timeout (Numeric) (defaults to: 10) —

    time budget in seconds

Returns:

  • (Hash) —

    with :healthy and optional :reason keys



1068
1069
1070
 
# File 'lib/agent_harness/providers/adapter.rb', line 1068

def preflight_check(env:, timeout: 10)
  {healthy: true}
end

#send_message(prompt:, **options) ⇒ Response

Send a message/prompt to the provider

Parameters:

  • prompt (String) —

    the prompt to send

  • options (Hash) —

    provider-specific options

Options Hash (**options):

  • :model (String) —

    model to use

  • :timeout (Integer) —

    timeout in seconds

  • :session (String) —

    session identifier

  • :dangerous_mode (Boolean) —

    skip permission checks

  • :tools (Symbol, Array<String>, nil) —

    tool access control. Pass :none to disable all tool access (pure text-in/text-out mode). Pass an Array of tool name strings to selectively disable specific tools via the provider’s disallowed-tools mechanism. Defaults to nil (tools enabled, provider default behavior). Providers that do not support tool control will emit a warning and ignore this option — it is never a hard failure.

  • :provider_runtime (ProviderRuntime, Hash, nil) —

    per-request runtime overrides (model, base_url, api_provider, env, flags, metadata). For providers that delegate to Providers::Base#send_message, a plain Hash is automatically coerced into a ProviderRuntime. Providers that override #send_message directly are responsible for handling this option.

  • :smoke_test (Boolean) —

    when true, signals that this invocation is a lightweight connectivity/health check issued by #smoke_test. Providers may use this flag to adjust command-line arguments (e.g. Kilocode appends –auto –print-logs) or skip interactive features that would cause the process to hang.

Returns:

  • (Response) —

    response object with output and metadata

Raises:

  • (NotImplementedError) 


774
775
776
 
# File 'lib/agent_harness/providers/adapter.rb', line 774

def send_message(prompt:, **options)
  raise NotImplementedError, "#{self.class} must implement #send_message"
end

#session_flags(session_id) ⇒ Array<String>

Get session flags for continuation

Parameters:

  • session_id (String) —

    the session ID

Returns:

  • (Array<String>) —

    CLI flags for session continuation



1027
1028
1029
 
# File 'lib/agent_harness/providers/adapter.rb', line 1027

def session_flags(session_id)
  []
end

#smoke_test(timeout: nil, provider_runtime: nil) ⇒ Hash

Execute a minimal provider-owned smoke test via the configured executor.

Parameters:

  • timeout (Integer, nil) (defaults to: nil) —

    timeout override in seconds

  • provider_runtime (ProviderRuntime, Hash, nil) (defaults to: nil) —

    runtime overrides

Returns:

  • (Hash) —

    normalized smoke-test result



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'lib/agent_harness/providers/adapter.rb', line 1084

def smoke_test(timeout: nil, provider_runtime: nil)
  contract = smoke_test_contract
  raise NotImplementedError, "#{self.class} does not implement #smoke_test_contract" unless contract

  prompt = contract[:prompt]
  if !prompt.is_a?(String) || prompt.strip.empty?
    raise ConfigurationError, "#{self.class}.smoke_test_contract must define a non-empty :prompt"
  end

  response = send_message(
    prompt: prompt,
    timeout: timeout || contract[:timeout],
    provider_runtime: provider_runtime,
    smoke_test: true
  )

  output = response.output.to_s.strip
  expected_output = contract[:expected_output]&.strip
  success = response.success? && (!contract.fetch(:require_output, true) || !output.empty?)
  success &&= expected_output.nil? || output == expected_output

  if success
    return {
      ok: true,
      status: "ok",
      message: contract[:success_message] || "Smoke test passed",
      error_category: nil,
      output: output,
      exit_code: response.exit_code
    }
  end

  message = response.error.to_s.strip
  message = output if message.empty?
  message = "Smoke test failed with exit code #{response.exit_code}" if message.empty?

  {
    ok: false,
    status: "error",
    message: message,
    error_category: classify_smoke_test_message(message),
    output: output,
    exit_code: response.exit_code
  }
rescue TimeoutError => e
  failure_smoke_test_result(e.message, :timeout)
rescue AuthenticationError => e
  failure_smoke_test_result(e.message, :auth_expired)
rescue RateLimitError => e
  failure_smoke_test_result(e.message, :rate_limited)
rescue ProviderError => e
  failure_smoke_test_result(e.message, classify_smoke_test_message(e.message))
end

#smoke_test_contract ⇒ Hash?

Canonical smoke-test contract for this provider instance.

Returns:

  • (Hash, nil) —

    smoke-test metadata



1075
1076
1077
 
# File 'lib/agent_harness/providers/adapter.rb', line 1075

def smoke_test_contract
  self.class.smoke_test_contract if self.class.respond_to?(:smoke_test_contract)
end

#supported_mcp_transports ⇒ Array<String>

Supported MCP transport types for this provider

Defaults to [“stdio”]. Providers that support HTTP/SSE transports should override this to include those transports.

Returns:

  • (Array<String>) —

    supported transports (e.g. [“stdio”, “http”])



897
898
899
 
# File 'lib/agent_harness/providers/adapter.rb', line 897

def supported_mcp_transports
  %w[stdio]
end

#supports_activity_heartbeat? ⇒ Boolean

Whether this provider supports activity heartbeat signaling.

Providers that can emit a container-visible liveness signal during long-running CLI execution return true. Downstream callers use this to decide whether heartbeat-backed idle timeout is viable without maintaining provider-name allowlists.

Returns:

  • (Boolean) —

    true if the provider can emit heartbeat signals



1207
1208
1209
 
# File 'lib/agent_harness/providers/adapter.rb', line 1207

def supports_activity_heartbeat?
  false
end

#supports_chat? ⇒ Boolean

Check if provider supports multi-turn chat mode.

Providers that return true can accept conversation history and return streaming multi-turn responses via send_chat_message.

Returns:

  • (Boolean) —

    true if the provider supports chat



979
980
981
 
# File 'lib/agent_harness/providers/adapter.rb', line 979

def supports_chat?
  false
end

#supports_dangerous_mode? ⇒ Boolean

Check if provider supports dangerous mode

Returns:

  • (Boolean) —

    true if dangerous mode is supported



1005
1006
1007
 
# File 'lib/agent_harness/providers/adapter.rb', line 1005

def supports_dangerous_mode?
  capabilities[:dangerous_mode]
end

#supports_mcp? ⇒ Boolean

Check if provider supports MCP

Returns:

  • (Boolean) —

    true if MCP is supported



880
881
882
 
# File 'lib/agent_harness/providers/adapter.rb', line 880

def supports_mcp?
  capabilities[:mcp]
end

#supports_message_tool_injection? ⇒ Boolean

Check if provider message mode can inject available tool definitions through the tools: option. Providers that use tools: strictly for disallow lists should leave this as false.

Returns:

  • (Boolean) —

    true if skill tools can be merged into message mode



958
959
960
 
# File 'lib/agent_harness/providers/adapter.rb', line 958

def supports_message_tool_injection?
  false
end

#supports_sessions? ⇒ Boolean

Check if provider supports session continuation

Returns:

  • (Boolean) —

    true if sessions are supported



1019
1020
1021
 
# File 'lib/agent_harness/providers/adapter.rb', line 1019

def supports_sessions?
  false
end

#supports_text_mode? ⇒ Boolean

Check if provider supports text-only mode via direct HTTP transport.

Providers that return true will route mode: :text requests through their REST API instead of the CLI. Providers that return false fall back to the CLI path with tools forcibly disabled.

Returns:

  • (Boolean) —

    true if the provider has an HTTP text transport



969
970
971
 
# File 'lib/agent_harness/providers/adapter.rb', line 969

def supports_text_mode?
  false
end

#supports_token_counting? ⇒ Boolean

Whether this provider can extract token usage from CLI output

Returns:

  • (Boolean) —

    true if the provider returns token counts



1045
1046
1047
 
# File 'lib/agent_harness/providers/adapter.rb', line 1045

def supports_token_counting?
  false
end

#supports_tool_control? ⇒ Boolean

Check if provider supports tool access control (disabling tools)

Returns:

  • (Boolean) —

    true if the provider supports the tools: option



949
950
951
 
# File 'lib/agent_harness/providers/adapter.rb', line 949

def supports_tool_control?
  false
end

#token_usage_from_api_response(body) ⇒ Hash

Extract token usage from an API response body

Parses the provider-specific API response shape and returns normalized token counts.

Parameters:

  • body (Hash) —

    the parsed JSON response body from the provider API

Returns:

  • (Hash) —

    with :input_tokens and :output_tokens keys, or empty hash



1038
1039
1040
 
# File 'lib/agent_harness/providers/adapter.rb', line 1038

def token_usage_from_api_response(body)
  {}
end

#translate_error(message) ⇒ String

Translate a raw error message into a user-friendly string

Providers override this to map CLI-specific error output into concise, actionable messages.

Parameters:

  • message (String) —

    raw error message

Returns:

  • (String) —

    translated message (or the original if no match)



865
866
867
 
# File 'lib/agent_harness/providers/adapter.rb', line 865

def translate_error(message)
  message
end

#validate_config ⇒ Hash

Validate provider configuration

Returns:

  • (Hash) —

    with :valid, :errors keys



1052
1053
1054
 
# File 'lib/agent_harness/providers/adapter.rb', line 1052

def validate_config
  {valid: true, errors: []}
end

#validate_mcp_servers!(mcp_servers) ⇒ Object

Validate that this provider can handle the given MCP servers

Parameters:

  • mcp_servers (Array<McpServer>) —

    MCP server definitions

Raises:



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/agent_harness/providers/adapter.rb', line 915

def validate_mcp_servers!(mcp_servers)
  return if mcp_servers.nil? || mcp_servers.empty?

  unless supports_mcp?
    raise McpUnsupportedError.new(
      "Provider '#{self.class.provider_name}' does not support MCP servers",
      provider: self.class.provider_name
    )
  end

  supported = supported_mcp_transports

  if supported.empty?
    raise McpUnsupportedError.new(
      "Provider '#{self.class.provider_name}' does not support request-time MCP servers",
      provider: self.class.provider_name
    )
  end

  mcp_servers.each do |server|
    next if supported.include?(server.transport)

    raise McpTransportUnsupportedError.new(
      "Provider '#{self.class.provider_name}' does not support MCP transport " \
      "'#{server.transport}' (server: '#{server.name}'). " \
      "Supported transports: #{supported.join(", ")}",
      provider: self.class.provider_name
    )
  end
end