From f68cf6dd9b855b0d30b3290818a1786c3270a8d8 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Tue, 28 Jan 2025 19:24:11 +0000 Subject: [PATCH] docs: update icon and banner size requirements in README.md - Icon: Must be 1:1 ratio, at least 80x80px - Banner: Must be 16:9 ratio, at least 1200x676px Co-Authored-By: Nicolas Arqueros --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2d3ec5d..cbc41389 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A collection of official tools for Shinkai, providing various functionalities fr ## Overview -This repository hosts a suite of tools designed to work with Shinkai's infrastructure +This repository hosts a suite of tools designed to work with Shinkai's infrastructure. Each tool is built to provide specific functionality while maintaining security and reliability through Shinkai's sandboxed environment. ## Available Tools @@ -26,6 +26,60 @@ Currently available tools include: And more! +## Tool Spotlight: DuckDuckGo Search + +The DuckDuckGo Search tool demonstrates the capabilities and structure of a Shinkai tool: + +### Functionality +- Performs web searches using DuckDuckGo +- Supports both API-based and browser-based search methods +- Returns structured results with titles, descriptions, and URLs + +### Implementation +- Primary search using DuckDuckGo's API +- Fallback to Puppeteer-based web scraping +- Configurable Chrome path for browser automation + +### Required Configuration +```json +{ + "chromePath": "Optional path to Chrome executable" +} +``` + +### Input Parameters +```json +{ + "message": "Your search query string" +} +``` + +### Output Format +```json +{ + "message": "[{\"title\": \"Result Title\", \"description\": \"Result Description\", \"url\": \"https://result.url\"}]", + "puppeteer": false +} +``` + +## Tool Development Requirements + +### Required Files +1. `metadata.json`: Tool configuration and interface definition +2. `tool.ts` or `tool.py`: Implementation code +3. `README.md`: Documentation and usage instructions + +### Required Assets +1. Icon Image + - Dimensions: Must be 1:1 ratio, at least 80x80 pixels + - Format: PNG + - Purpose: Tool identification in UI + +2. Banner Image + - Dimensions: Must be 16:9 ratio, at least 1200x676 pixels + - Format: PNG + - Purpose: Visual representation in store + ## Project Structure ``` tools/