sii_web_search - SII Web Search

Overview

The sii_web_search tool performs web searches using the SII backend search service and returns results. This tool is useful for finding information on the internet based on a query.

Tool Name

• Internal Name: sii_web_search
• Display Name: SII Search
• Icon: Globe

Prerequisites

To use this tool, you need:

1. SII Account: A valid SII account is required
2. Environment Variables:
   • SII_USERNAME: SII username
   • SII_PASSWORD: SII password
   • SII_BASE_URL: SII backend URL (optional, defaults to https://www.opensii.ai/backend)

Parameters

Required Parameters

Parameter	Type	Description
query	string	The search query to find information on the web.

Features

1. Web Search:

   • Uses SII backend search engine
   • Returns relevant web results
   • Includes titles, URLs, and summaries

2. Result Formatting:

   • Clear result presentation
   • Includes source links
   • Provides content summaries

3. Authentication Management:

   • Automatically handles token authentication
   • Supports token refresh
   • Handles authentication errors

4. Error Handling:

   • Clear error messages
   • Automatic retry mechanism
   • Network error handling

Usage Examples

Basic Search

{
  "query": "latest AI developments"
}

Technical Search

{
  "query": "React 18 new features"
}

Academic Search

{
  "query": "transformer model architecture"
}

News Search

{
  "query": "2024 technology trends"
}

Return Value

The tool returns an object containing:

• llmContent: Formatted search results text
• returnDisplay: User-friendly display information
• sources: Array of search results

Search Result Format

Each search result contains:

{
  title: string;      // Result title
  url: string;        // Result URL
  snippet: string;    // Content summary
  source: string;     // Source name
}

Error Handling

Possible error scenarios:

1. Authentication Errors:

   • Invalid credentials
   • Expired token
   • Missing environment variables

2. Network Errors:

   • Connection timeout
   • Service unavailable
   • Network interruption

3. Query Errors:

   • Empty query
   • Invalid query format
   • Query too long

Authentication Setup

Setting Environment Variables

Linux/macOS:

export SII_USERNAME="your_username"
export SII_PASSWORD="your_password"
export SII_BASE_URL="https://www.opensii.ai/backend"  # Optional

Windows (PowerShell):

$env:SII_USERNAME="your_username"
$env:SII_PASSWORD="your_password"
$env:SII_BASE_URL="https://www.opensii.ai/backend"  # Optional

Using Configuration File

You can also configure credentials in the SII CLI configuration file:

{
  "sii": {
    "username": "your_username",
    "password": "your_password",
    "baseUrl": "https://www.opensii.ai/backend"
  }
}

Best Practices

1. Query Optimization:

   • Use specific keywords
   • Include relevant context
   • Avoid overly broad queries

2. Result Processing:

   • Review result relevance
   • Check source credibility
   • Verify information accuracy

3. Error Handling:

   • Check authentication status
   • Handle network errors gracefully
   • Implement retry logic

4. Security:

   • Keep credentials secure
   • Don't commit credentials to version control
   • Use environment variables or secure configuration

Rate Limiting

The SII web search service may have rate limits:

• Maximum queries per minute
• Maximum queries per day
• Concurrent request limits

If you encounter rate limiting errors, wait before retrying.

Notes

1. Authentication Required: This tool requires SII authentication
2. Network Connection: Requires active internet connection
3. Result Quality: Result quality depends on the search query
4. Language Support: Supports multiple languages

Related Tools

• sii_cognitions: Search SII cognitions database
• sii_deep_research: Conduct comprehensive research
• sii_hybrid_search: Combined web and cognition search
• sii_web_fetch: Fetch content from URLs