Class: AgentHarness::Providers::Gemini

Inherits:
Base
  • Object
show all
Defined in:
lib/agent_harness/providers/gemini.rb

Overview

Google Gemini CLI provider

Provides integration with the Google Gemini CLI tool.

Constant Summary collapse

MODEL_PATTERN =

Model name pattern for Gemini models

/^gemini-[\d.]+-(?:pro|flash|ultra)(?:-\d+)?$/i
CLI_PACKAGE = 
"@google/gemini-cli"
SUPPORTED_CLI_VERSION = 
"0.35.3"
SUPPORTED_CLI_REQUIREMENT = 
Gem::Requirement.new("= #{SUPPORTED_CLI_VERSION}").freeze

Constants inherited from Base

Base::COMMON_ERROR_PATTERNS, Base::DEFAULT_SMOKE_TEST_CONTRACT

Instance Attribute Summary

Attributes inherited from Base

#config, #executor, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#configure, #initialize, #parse_rate_limit_reset, #sandboxed_environment?, #send_message, #test_command_overrides

Methods included from Adapter

#auth_lock_config, #build_mcp_flags, #config_file_content, #dangerous_mode_flags, #fetch_mcp_servers, included, metadata_package_name, normalize_metadata_installation, normalize_metadata_source_type, normalize_metadata_version_requirement, #notify_hook_content, #parse_rate_limit_reset, #send_message, #session_flags, #smoke_test, #smoke_test_contract, #supported_mcp_transports, #supports_dangerous_mode?, #supports_mcp?, #supports_sessions?, #supports_text_mode?, #supports_token_counting?, #supports_tool_control?, #validate_mcp_servers!

Constructor Details

This class inherits a constructor from AgentHarness::Providers::Base

Class Method Details

.available? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
31
 
# File 'lib/agent_harness/providers/gemini.rb', line 28

def available?
  executor = AgentHarness.configuration.command_executor
  !!executor.which(binary_name)
end

.binary_name ⇒ Object 



24
25
26
 
# File 'lib/agent_harness/providers/gemini.rb', line 24

def binary_name
  "gemini"
end

.discover_models ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/agent_harness/providers/gemini.rb', line 96

def discover_models
  return [] unless available?

  # Gemini CLI doesn't have a standard model listing command
  # Return common models
  [
    {name: "gemini-2.0-flash", family: "gemini-2-0-flash", tier: "standard", provider: "gemini"},
    {name: "gemini-2.5-pro", family: "gemini-2-5-pro", tier: "advanced", provider: "gemini"},
    {name: "gemini-1.5-pro", family: "gemini-1-5-pro", tier: "standard", provider: "gemini"},
    {name: "gemini-1.5-flash", family: "gemini-1-5-flash", tier: "mini", provider: "gemini"}
  ]
end

.firewall_requirements ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/agent_harness/providers/gemini.rb', line 74

def firewall_requirements
  {
    domains: [
      "generativelanguage.googleapis.com",
      "oauth2.googleapis.com",
      "accounts.google.com",
      "www.googleapis.com"
    ],
    ip_ranges: []
  }
end

.install_contract(version: SUPPORTED_CLI_VERSION) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/agent_harness/providers/gemini.rb', line 42

def install_contract(version: SUPPORTED_CLI_VERSION)
  version = version.strip if version.respond_to?(:strip)

  unless version.is_a?(String) && !version.empty?
    raise ArgumentError, "Unsupported Gemini CLI version #{version.inspect}. Supported requirement: #{SUPPORTED_CLI_REQUIREMENT}"
  end

  parsed_version = begin
    Gem::Version.new(version)
  rescue ArgumentError
    raise ArgumentError, "Unsupported Gemini CLI version #{version.inspect}. Supported requirement: #{SUPPORTED_CLI_REQUIREMENT}"
  end

  unless SUPPORTED_CLI_REQUIREMENT.satisfied_by?(parsed_version)
    raise ArgumentError, "Unsupported Gemini CLI version #{version.inspect}. Supported requirement: #{SUPPORTED_CLI_REQUIREMENT}"
  end

  package_spec = "#{CLI_PACKAGE}@#{version}"

  {
    provider: provider_name,
    source_type: :npm,
    package_name: CLI_PACKAGE,
    supported_version_requirement: SUPPORTED_CLI_REQUIREMENT,
    default_version: SUPPORTED_CLI_VERSION,
    resolved_version: version,
    binary_name: binary_name,
    install_command: ["npm", "install", "-g", "--ignore-scripts", package_spec],
    install_command_string: "npm install -g --ignore-scripts #{package_spec}"
  }
end

.instruction_file_paths ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/agent_harness/providers/gemini.rb', line 86

def instruction_file_paths
  [
    {
      path: "GEMINI.md",
      description: "Google Gemini agent instructions",
      symlink: true
    }
  ]
end

.model_family(provider_model_name) ⇒ Object 



109
110
111
112
 
# File 'lib/agent_harness/providers/gemini.rb', line 109

def model_family(provider_model_name)
  # Strip version suffix: "gemini-1.5-pro-001" -> "gemini-1.5-pro"
  provider_model_name.sub(/-\d+$/, "")
end

.provider_metadata_overrides ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/agent_harness/providers/gemini.rb', line 33

def provider_metadata_overrides
  {
    auth: {
      service: :google,
      api_family: :gemini
    }
  }
end

.provider_model_name(family_name) ⇒ Object 



114
115
116
 
# File 'lib/agent_harness/providers/gemini.rb', line 114

def provider_model_name(family_name)
  family_name
end

.provider_name ⇒ Object 



20
21
22
 
# File 'lib/agent_harness/providers/gemini.rb', line 20

def provider_name
  :gemini
end

.smoke_test_contract ⇒ Object 



122
123
124
 
# File 'lib/agent_harness/providers/gemini.rb', line 122

def smoke_test_contract
  Base::DEFAULT_SMOKE_TEST_CONTRACT
end

.supports_model_family?(family_name) ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/agent_harness/providers/gemini.rb', line 118

def supports_model_family?(family_name)
  MODEL_PATTERN.match?(family_name) || family_name.start_with?("gemini-")
end

Instance Method Details

#api_key_env_var_names ⇒ Object 



180
 
# File 'lib/agent_harness/providers/gemini.rb', line 180

def api_key_env_var_names = ["GEMINI_API_KEY", "GOOGLE_API_KEY"]

#api_key_unset_vars ⇒ Object 



182
 
# File 'lib/agent_harness/providers/gemini.rb', line 182

def api_key_unset_vars = ["GOOGLE_GEMINI_BASE_URL", "GOOGLE_GENAI_BASE_URL", "GEMINI_CLI_CUSTOM_HEADERS"]

#auth_status ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/agent_harness/providers/gemini.rb', line 273

def auth_status
  api_key = [ENV["GEMINI_API_KEY"], ENV["GOOGLE_API_KEY"]].find { |key| key && !key.strip.empty? }
  if api_key
    return {valid: true, expires_at: nil, error: nil, auth_method: :api_key}
  end

  credentials = read_gemini_credentials
  return {valid: false, expires_at: nil, error: "No Gemini credentials found. Run 'gemini auth login' or set GEMINI_API_KEY or GOOGLE_API_KEY", auth_method: nil} unless credentials

  token = credentials["access_token"] || credentials["oauth_token"]
  unless token.is_a?(String) && !token.strip.empty?
    return {valid: false, expires_at: nil, error: "No authentication token in Gemini credentials", auth_method: nil}
  end

  expires_at = parse_gemini_expiry(credentials)
  if expires_at && expires_at < Time.now
    {valid: false, expires_at: expires_at, error: "Gemini session expired. Run 'gemini auth login' to re-authenticate", auth_method: :oauth}
  else
    {valid: true, expires_at: expires_at, error: nil, auth_method: :oauth}
  end
rescue IOError, JSON::ParserError => e
  {valid: false, expires_at: nil, error: e.message, auth_method: nil}
end

#auth_type ⇒ Object 



193
194
195
 
# File 'lib/agent_harness/providers/gemini.rb', line 193

def auth_type
  :oauth
end

#capabilities ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/agent_harness/providers/gemini.rb', line 154

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

#cli_env_overrides ⇒ Object 



186
187
188
189
190
191
 
# File 'lib/agent_harness/providers/gemini.rb', line 186

def cli_env_overrides
  {
    "GEMINI_SANDBOX" => "false",
    "GEMINI_CLI_DISABLE_RETRIES" => "true"
  }
end

#configuration_schema ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/agent_harness/providers/gemini.rb', line 135

def configuration_schema
  {
    fields: [
      {
        name: :model,
        type: :string,
        label: "Model",
        required: false,
        hint: "Gemini model to use (e.g. gemini-2.5-pro, gemini-2.0-flash)",
        # accepts_arbitrary is true because supports_model_family? accepts
        # any string starting with "gemini-", not just discovered models.
        accepts_arbitrary: true
      }
    ],
    auth_modes: [:api_key, :oauth],
    openai_compatible: false
  }
end

#display_name ⇒ Object 



131
132
133
 
# File 'lib/agent_harness/providers/gemini.rb', line 131

def display_name
  "Google Gemini"
end

#error_classification_patterns ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/agent_harness/providers/gemini.rb', line 244

def error_classification_patterns
  super.merge(
    authentication: [
      /GEMINI_API_KEY/i,
      /GOOGLE_GENAI_USE_VERTEXAI/i,
      /GOOGLE_GENAI_USE_GCA/i,
      /ValidationRequiredError/i,
      /API key not configured for google/i,
      /API key not valid/i
    ]
  )
end

#error_patterns ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/agent_harness/providers/gemini.rb', line 220

def error_patterns
  {
    rate_limited: [
      /rate.?limit/i,
      /quota.?exceeded/i,
      /\b429\b/
    ],
    auth_expired: [
      /authentication/i,
      /unauthorized/i,
      /invalid.?credentials/i,
      /login.*required/i,
      /not.*logged.*in/i,
      /credentials.*expired/i,
      /account.*not.*verified/i
    ],
    transient: [
      /timeout/i,
      /temporary/i,
      /\b503\b/
    ]
  }
end

#execution_semantics ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/agent_harness/providers/gemini.rb', line 207

def execution_semantics
  {
    prompt_delivery: :flag,
    output_format: :text,
    sandbox_aware: false,
    uses_subcommand: false,
    non_interactive_flag: nil,
    legitimate_exit_codes: [0],
    stderr_is_diagnostic: true,
    parses_rate_limit_reset: false
  }
end

#health_status ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/agent_harness/providers/gemini.rb', line 297

def health_status
  unless self.class.available?
    return {healthy: false, message: "Gemini CLI not found in PATH. Install from https://github.com/google-gemini/gemini-cli"}
  end

  auth = auth_status
  unless auth[:valid]
    return {healthy: false, message: auth[:error]}
  end

  {healthy: true, message: "Gemini CLI available and authenticated"}
end

#name ⇒ Object 



127
128
129
 
# File 'lib/agent_harness/providers/gemini.rb', line 127

def name
  "gemini"
end

#noisy_error_patterns ⇒ Object 



257
258
259
260
261
262
263
264
 
# File 'lib/agent_harness/providers/gemini.rb', line 257

def noisy_error_patterns
  [
    /Error when talking to Gemini API/i,
    /service=.*status/i,
    /loading\.\.\./i,
    /subscribing/i
  ]
end

#parse_test_error(output:, files: {}) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/agent_harness/providers/gemini.rb', line 166

def parse_test_error(output:, files: {})
  error_file = files.values.find { |path| path.match?(/gemini-client-error-.*\.json/) }
  return nil unless error_file

  error_data = begin
    JSON.parse(File.read(error_file))
  rescue JSON::ParserError, Errno::ENOENT
    nil
  end
  return nil unless error_data

  {message: error_data.dig("error", "message") || output, type: :configuration}
end

#subscription_unset_vars ⇒ Object 



184
 
# File 'lib/agent_harness/providers/gemini.rb', line 184

def subscription_unset_vars = ["GEMINI_API_KEY", "GOOGLE_GEMINI_BASE_URL", "GOOGLE_GENAI_BASE_URL", "GEMINI_CLI_CUSTOM_HEADERS"]

#token_usage_from_api_response(body) ⇒ Object 



197
198
199
200
201
202
203
204
205
 
# File 'lib/agent_harness/providers/gemini.rb', line 197

def token_usage_from_api_response(body)
  usage = body&.dig("usageMetadata")
  return {} unless usage

  {
    input_tokens: usage["promptTokenCount"].to_i,
    output_tokens: usage["candidatesTokenCount"].to_i
  }
end

#translate_error(message) ⇒ Object 



266
267
268
269
270
271
 
# File 'lib/agent_harness/providers/gemini.rb', line 266

def translate_error(message)
  case message
  when /API key not configured/i then "Gemini API key not set. Run: export GEMINI_API_KEY=..."
  else message
  end
end

#validate_config ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/agent_harness/providers/gemini.rb', line 310

def validate_config
  errors = []

  model = @config.model
  if !model.nil? && !model.is_a?(String)
    errors << "model must be a string"
  elsif model.is_a?(String) && !model.empty?
    unless self.class.supports_model_family?(model)
      errors << "Unrecognized model '#{model}'. Expected a Gemini model (e.g., gemini-2.0-flash, gemini-2.5-pro)"
    end
  end

  flags = @config.default_flags
  unless flags.nil?
    if flags.is_a?(Array)
      invalid = flags.reject { |f| f.is_a?(String) }
      errors << "default_flags contains non-string values" if invalid.any?
    else
      errors << "default_flags must be an array of strings"
    end
  end

  {valid: errors.empty?, errors: errors}
end