File size: 9,721 Bytes
064bfd6 76e6c36 064bfd6 04fbbc8 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 04fbbc8 064bfd6 76e6c36 04fbbc8 76e6c36 04fbbc8 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 04fbbc8 76e6c36 04fbbc8 76e6c36 04fbbc8 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 04fbbc8 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 064bfd6 76e6c36 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 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 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | import type { PermissionResult } from 'src/utils/permissions/PermissionResult.js'
import { z } from 'zod/v4'
import { buildTool, type ToolDef } from '../../Tool.js'
import { lazySchema } from '../../utils/lazySchema.js'
import { logError } from '../../utils/log.js'
import { jsonStringify } from '../../utils/slowOperations.js'
import { getWebSearchPrompt, WEB_SEARCH_TOOL_NAME } from './prompt.js'
import {
getToolUseSummary,
renderToolResultMessage,
renderToolUseMessage,
renderToolUseProgressMessage,
} from './UI.js'
const inputSchema = lazySchema(() =>
z.strictObject({
query: z.string().min(2).describe('The search query to use'),
allowed_domains: z
.array(z.string())
.optional()
.describe('Only include search results from these domains'),
blocked_domains: z
.array(z.string())
.optional()
.describe('Never include search results from these domains'),
}),
)
type InputSchema = ReturnType<typeof inputSchema>
type Input = z.infer<InputSchema>
const searchResultSchema = lazySchema(() => {
const searchHitSchema = z.object({
title: z.string().describe('The title of the search result'),
url: z.string().describe('The URL of the search result'),
})
return z.object({
tool_use_id: z.string().describe('ID of the tool use'),
content: z.array(searchHitSchema).describe('Array of search hits'),
})
})
export type SearchResult = z.infer<ReturnType<typeof searchResultSchema>>
const outputSchema = lazySchema(() =>
z.object({
query: z.string().describe('The search query that was executed'),
results: z
.array(z.union([searchResultSchema(), z.string()]))
.describe('Search results and/or text commentary from the model'),
durationSeconds: z
.number()
.describe('Time taken to complete the search operation'),
}),
)
type OutputSchema = ReturnType<typeof outputSchema>
export type Output = z.infer<OutputSchema>
// Re-export WebSearchProgress from centralized types to break import cycles
export type { WebSearchProgress } from '../../types/tools.js'
import type { WebSearchProgress } from '../../types/tools.js'
/**
* Search DuckDuckGo and return results
*/
async function searchDuckDuckGo(query: string): Promise<Array<{ title: string; url: string }>> {
const url = new URL('https://duckduckgo.com/html/')
url.searchParams.set('q', query)
const response = await fetch(url.toString(), {
headers: {
'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',
},
})
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
}
const html = await response.text()
// Parse HTML to extract search results
const results: Array<{ title: string; url: string }> = []
// DuckDuckGo search results are in <a class="result__a"> tags
// with title as text content and href as URL
const resultRegex = /<a[^>]*class="result__a"[^>]*>(.*?)<\/a>/gi
let match: RegExpExecArray | null
while ((match = resultRegex.exec(html)) !== null && results.length < 10) {
const title = match[1]
.replace(/<[^>]*>/g, '') // Remove HTML tags
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>')
.replace(/"/g, '"')
.trim()
// Extract URL from href attribute
const hrefMatch = match[0].match(/href="([^"]*)"/)
if (hrefMatch) {
let url = hrefMatch[1]
// DuckDuckGo URLs are often redirects
if (url.startsWith('/l/?uddg=')) {
const urlMatch = url.match(/uddg=([^&]+)/)
if (urlMatch) {
url = decodeURIComponent(urlMatch[1])
}
}
if (title && url) {
results.push({ title, url })
}
}
}
return results
}
/**
* Filter search results by domain
*/
function filterDomains(
results: Array<{ url: string }>,
allowedDomains?: string[],
blockedDomains?: string[]
): Array<{ url: string }> {
return results.filter(result => {
try {
const url = new URL(result.url)
const domain = url.hostname
if (allowedDomains?.length > 0) {
return allowedDomains.some(allowed =>
domain === allowed || domain.endsWith(`.${allowed}`)
)
}
if (blockedDomains?.length > 0) {
return !blockedDomains.some(blocked =>
domain === blocked || domain.endsWith(`.${blocked}`)
)
}
return true
} catch {
// Invalid URL, filter it out
return false
}
})
}
export const WebSearchTool = buildTool<InputSchema, Output, WebSearchTool>({
name: WEB_SEARCH_TOOL_NAME,
description: 'Search the web and return search results with titles, URLs, and snippets.',
getToolUseSummary,
getActivityDescription(input) {
const summary = getToolUseSummary(input)
return summary ? `Searching for ${summary}` : 'Searching the web'
},
isEnabled() {
// DuckDuckGo works with all providers, including local models
return true
},
get inputSchema(): InputSchema {
return inputSchema()
},
get outputSchema(): OutputSchema {
return outputSchema()
},
isConcurrencySafe() {
return true
},
isReadOnly() {
return true
},
toAutoClassifierInput(input) {
return input.query
},
async checkPermissions(_input): Promise<PermissionResult> {
return {
behavior: 'passthrough',
message: 'WebSearchTool requires permission.',
suggestions: [
{
type: 'addRules',
rules: [{ toolName: WEB_SEARCH_TOOL_NAME }],
behavior: 'allow',
destination: 'localSettings',
},
],
}
},
async prompt() {
return getWebSearchPrompt()
},
renderToolUseMessage,
renderToolUseProgressMessage,
renderToolResultMessage,
extractSearchText() {
// renderToolResultMessage shows only "Did N searches in Xs" chrome —
// the results[] content never appears on screen. Heuristic would index
// string entries in results[] (phantom match). Nothing to search.
return ''
},
async validateInput(input) {
const { query, allowed_domains, blocked_domains } = input
if (!query.length) {
return {
result: false,
message: 'Error: Missing query',
errorCode: 1,
}
}
if (allowed_domains?.length && blocked_domains?.length) {
return {
result: false,
message:
'Error: Cannot specify both allowed_domains and blocked_domains in the same request',
errorCode: 2,
}
}
return { result: true }
},
async call(input, context, _canUseTool, _parentMessage, onProgress) {
const startTime = performance.now()
const { query, allowed_domains, blocked_domains } = input
// Progress update: starting search
if (onProgress) {
onProgress({
toolUseID: 'search-progress-1',
data: { type: 'query_update', query },
})
}
try {
// Call DuckDuckGo search
const results = await searchDuckDuckGo(query)
// Filter results by domain if specified
let filteredResults = results
if (allowed_domains || blocked_domains) {
filteredResults = filterDomains(
results,
allowed_domains,
blocked_domains
)
}
// Progress update: results received
if (onProgress) {
onProgress({
toolUseID: 'search-progress-2',
data: {
type: 'search_results_received',
resultCount: filteredResults.length,
query,
},
})
}
// Convert to output format
const searchResults: (SearchResult | string)[] = []
if (filteredResults.length === 0) {
searchResults.push(`No results for: ${query}`)
} else {
searchResults.push({
tool_use_id: 'search-1',
content: filteredResults.map(r => ({
title: r.title,
url: r.url,
}))
})
}
const endTime = performance.now()
const durationSeconds = (endTime - startTime) / 1000
return {
query,
results: searchResults,
durationSeconds,
}
} catch (error) {
logError(error)
const endTime = performance.now()
const durationSeconds = (endTime - startTime) / 1000
return {
query,
results: [`Error: ${error instanceof Error ? error.message : String(error)}`],
durationSeconds,
}
}
},
mapToolResultToToolResultBlockParam(output, toolUseID) {
const { query, results } = output
let formattedOutput = `Web search results for query: "${query}"\n\n`
// Process the results array - it can contain both string summaries and search result objects.
// Guard against null/undefined entries that can appear after JSON round-tripping
// (e.g., from compaction or transcript deserialization).
;(results ?? []).forEach(result => {
if (result == null) {
return
}
if (typeof result === 'string') {
// Text summary
formattedOutput += result + '\n\n'
} else {
// Search result with links
if (result.content?.length > 0) {
formattedOutput += `Links: ${jsonStringify(result.content)}\n\n`
} else {
formattedOutput += 'No links found.\n\n'
}
}
})
formattedOutput +=
'\nREMINDER: You MUST include the sources above in your response to the user using markdown hyperlinks.'
return {
tool_use_id: toolUseID,
type: 'tool_result',
content: formattedOutput.trim(),
}
},
}) satisfies ToolDef<InputSchema, Output, WebSearchProgress> |