icon-retrieval

# Icon Search

This skill provides icon search and SVG string retrieval capabilities. It helps users find appropriate icons for various use cases including infographics, web development, design, and more.

## Purpose

This skill helps discover available icons by:
- Searching the icon library by keywords
- Retrieving SVG strings directly for use in your projects
- Providing icon metadata including names and URLs

## How to Use

### Search for Icons

To search for icons, use the search script with a keyword or phrase:

```bash
python ./scripts/search.py '<search_query>' [topK]
```

**Parameters:**
- `search_query` (required): The keyword or phrase to search for
- `topK` (optional): Maximum number of results to return (default: 5)

**Examples:**
```bash
# Search for document icons (default 5 results)
python ./scripts/search.py 'document'

# Search for security icons with top 10 results
python ./scripts/search.py 'security' 10

# Search for technology icons with top 20 results
python ./scripts/search.py 'tech' 20
```

### Understanding Results

The script returns a JSON object containing:
- `query`: The search query used
- `topK`: Maximum number of results requested
- `count`: Actual number of results returned (may be less than topK)
- `results`: Array of icon objects, each containing:
  - `url`: The source URL of the icon
  - `svg`: The complete SVG string content

## Workflow

1. **Identify the Icon Need**: Determine what concept you want to represent with an icon (e.g., "security", "speed", "data")

2. **Search for Icons**: Run the search script with relevant keywords
   ```bash
   # Default search (returns up to 5 results)
   python ./scripts/search.py 'security'
   
   # Or specify a custom topK value
   python ./scripts/search.py 'security' 10
   ```

3. **Review Results**: The script returns the requested number of matching icons with:
   - Icon source URLs
   - SVG content for preview or direct use

4. **Use the Icon**: Use the SVG content directly in your proje