update app

README.md

@@ -12,4 +12,86 @@ tags:
 - tool
 ---
 
+# 🔍 Linkup Web Search Tool
+
+The **Linkup Search Tool** is a [SmolAgents](https://github.com/huggingface/smolagents)–compatible tool that allows agents to search the public and premium web in real-time using the [Linkup API](https://linkup.so).
+
+Powered by advanced depth-aware search logic (`standard` vs `deep`), this tool is ideal for retrieving up-to-date insights, articles, and structured search summaries — all within your SmolAgents or Python workflows.
+
+---
+
+## 🚀 Features
+
+- 🌐 **Web-wide, real-time search** via Linkup API  
+- 🧠 Supports **depth-aware querying** (`standard` or `deep`)  
+- 🤖 Compatible with `smolagents.CodeAgent` and manual usage  
+
+---
+
+## 📦 Installation
+
+```bash
+pip install linkup-sdk smolagents
+```
+
+You’ll also need a [Linkup API key](https://linkup.so) to use the tool. You get $5 credits on signing up to try it out.
+
+---
+
+## 🔑 Setup API Key
+
+You can provide the API key:
+- At runtime
+- Or by setting the environment variable:
+
+```bash
+export LINKUP_API_KEY="your-linkup-api-key"
+```
+
+You **must** however pass the `linkup_api_key` as a parameter in the space plug-and-play.  
+This ensures safe and personalized access to your Linkup account in public environments.
+
+---
+
+## 🧠 Usage with SmolAgents
+
+```python
+from smolagents import load_tool
+
+tool = load_tool("Linkup-Platform/linkup-search-tool", trust_remote_code=True)
+
+tool.forward(
+    query="What are the latest trends in generative AI?",
+    depth="deep",
+)
+```
+---
+
+## 🎯 When to Use `standard` vs `deep`
+
+| Mode       | Best For                                      |
+|------------|-----------------------------------------------|
+| `standard` | Quick factual lookups, direct answers         |
+| `deep`     | Complex topics, analysis, multiple perspectives, latest news |
+
+---
+
+## 💬 Example Result (truncated)
+
+```markdown
+**Search Results:**
+
+1. **The State of Generative AI 2024**
+URL: https://venturebeat.com/generative-ai-2024
+Generative AI is reshaping industries, with key players like OpenAI, Anthropic, and Google DeepMind...
+
+2. **AI Trends: What's Coming Next?**
+URL: https://techcrunch.com/ai-trends-2024
+This year we’ll see more foundation model APIs, compliance tooling, and multi-modal agents...
+```
+
+---
+
+For questions or API access, visit [linkup.so](https://linkup.so).
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -1,39 +1,74 @@
 import gradio as gr
-from tool import LinkupSearchTool  # Assuming this is your tool class
+from tool import LinkupSearchTool
 
 def run_search(query, depth, api_key):
-    if not query or not depth or not api_key:
+    if not query.strip() or not depth or not api_key.strip():
         return "❌ All fields are required."
-    
+
     try:
-        # Initialize tool ONLY when we have the API key
-        tool = LinkupSearchTool(linkup_api_key=api_key)  # Pass API key to constructor
+        tool = LinkupSearchTool(linkup_api_key=api_key)
         return tool.forward(query=query, depth=depth)
     except Exception as e:
         return f"❌ Error: {str(e)}"
 
-with gr.Blocks() as demo:
-    gr.Markdown("## 🔍 Linkup Web Search Tool")
-    
+def enable_submit(q, d, k):
+    return gr.Button.update(interactive=bool(q.strip() and d and k.strip()))
+
+with gr.Blocks(title="Linkup Web Search Tool") as demo:
+    gr.Markdown(
+        """
+        # 🔍 Linkup Web Search Tool
+        Perform real-time web search using [Linkup API](https://linkup.so).
+
+        🧠 Supports `standard` and `deep` query depth.  
+        🔐 Requires your personal Linkup API key.  
+        💡 Ideal for facts, trends, research, and real-time data discovery.
+        """,
+        elem_id="header",
+    )
+
     with gr.Row():
-        query_input = gr.Textbox(label="Search Query", placeholder="e.g. AI trends in 2024")
-        depth_input = gr.Dropdown(label="Search Depth", choices=["standard", "deep"], value="standard")
-        api_key_input = gr.Textbox(label="Linkup API Key", type="password")
-    
-    output = gr.Markdown()
-    btn = gr.Button("Search", interactive=True)
-    
-    btn.click(
+        query_input = gr.Textbox(
+            label="Search Query",
+            placeholder="e.g. AI trends in 2024",
+            lines=1,
+        )
+        depth_input = gr.Dropdown(
+            label="Search Depth",
+            choices=["standard", "deep"],
+            value="standard",
+            allow_custom_value=False,
+        )
+        api_key_input = gr.Textbox(
+            label="Linkup API Key",
+            placeholder="Paste your Linkup API key here",
+            type="password",
+        )
+
+    search_btn = gr.Button("🔍 Search", interactive=False)
+    output = gr.Markdown("💬 *Enter a query and click Search to begin.*", elem_id="output")
+
+    # Loading spinner and search button connection
+    search_btn.click(
         fn=run_search,
         inputs=[query_input, depth_input, api_key_input],
-        outputs=output
+        outputs=output,
+        show_progress=True,
     )
-    
-    def enable_submit(q, d, k):
-        return gr.Button.update(interactive=bool(q.strip() and d and k.strip()))
-    
-    query_input.change(enable_submit, [query_input, depth_input, api_key_input], [btn])
-    depth_input.change(enable_submit, [query_input, depth_input, api_key_input], [btn])
-    api_key_input.change(enable_submit, [query_input, depth_input, api_key_input], [btn])
-
-demo.launch()
+
+    # Dynamic form validation
+    query_input.input(enable_submit, [query_input, depth_input, api_key_input], [search_btn])
+    depth_input.input(enable_submit, [query_input, depth_input, api_key_input], [search_btn])
+    api_key_input.input(enable_submit, [query_input, depth_input, api_key_input], [search_btn])
+
+    # Footer
+    gr.Markdown(
+        """
+        ---
+        ✅ Built with [SmolAgents](https://github.com/huggingface/smolagents) + [Gradio](https://gradio.app)  
+        🔗 Powered by [Linkup](https://linkup.so)
+        """,
+        elem_id="footer",
+    )
+
+demo.launch()

requirements.txt

@@ -1,3 +1,3 @@
-linkup-sdk
+linkup-sdk==0.2.4
 smolagents
 gradio

tool.py

@@ -1,33 +1,37 @@
-from typing import Any, Literal, Optional
+from typing import Literal
+
 from smolagents.tools import Tool
 
 class LinkupSearchTool(Tool):
     """LinkupSearchTool tool.
 
-LinkupSearchTool performs web search queries using the Linkup API, which includes results from both
-public and premium web sources. It supports two modes of search depth — standard and deep — allowing
-for flexible information retrieval depending on the complexity of the query.
+    LinkupSearchTool performs web search queries using the Linkup API, which includes results from both
+    public and premium web sources. It supports two modes of search depth — standard and deep — allowing
+    for flexible information retrieval depending on the complexity of the query.
+
+    Setup:
+        Make sure your Linkup API key is exported to the environment:
+
+        .. code-block:: bash
 
-Setup:
-    Make sure your Linkup API key is exported to the environment:
+            pip install linkup-sdk
+            export LINKUP_API_KEY="your-api-key"
 
-    .. code-block:: bash
+    Example:
+            from smolagents import load_tool, CodeAgent, InferenceClientModel
 
-        pip install linkup-sdk
-        export LINKUP_API_KEY="your-api-key"
+            linkup_tool = load_tool("Linkup-Platform/linkup-search-tool", trust_remote_code=True)
 
-Example:
-        from smolagents import load_tool, CodeAgent, InferenceClientModel
+            agent = CodeAgent(
+                tools=[linkup_tool()],
+                model=InferenceClientModel(),
+            )
+            agent.run(query="What was Microsoft's revenue last quarter and was it well perceived by the market?", depth="deep")
 
-        agent = CodeAgent(
-            tools=[LinkupSearchTool()],
-            model=InferenceClientModel(),
-        )
-        agent.run(query="What was Microsoft's revenue last quarter and was it well perceived by the market?", depth="deep")
+    Args:
+        linkup_api_key (str | None): Optional. If not provided, LinkupClient will check the LINKUP_API_KEY env variable.
+    """
 
-Args:
-    linkup_api_key (str | None): Optional. If not provided, LinkupClient will check the LINKUP_API_KEY env variable.
-"""
     name = "search_web"
     description = "Performs an online search using Linkup search engine and retrieves the top results as a string. This function is useful for accessing real-time information, including news, articles, and other relevant web content."
     output_type = "string"
@@ -40,7 +44,7 @@ Args:
             "description": "The search depth to perform. Use 'standard' for straightforward queries with likely direct answers (e.g., facts, definitions, simple explanations). Use 'deep' for: 1) complex queries requiring comprehensive analysis or information synthesis, 2) queries containing uncommon terms, specialized jargon, or abbreviations that may need additional context, or 3) questions likely requiring up-to-date or specialized web search results to answer effectively.",
         },
     }
-    
+
     def __init__(self, linkup_api_key: str | None = None, **kwargs) -> None:
         super().__init__()
         try:
@@ -52,10 +56,7 @@ Args:
 
         self.client = LinkupClient(api_key=linkup_api_key)
 
-    def forward(self, query: str, depth: str) -> str:
-
-        if depth not in ["standard", "deep"]:
-            raise ValueError("depth must be 'standard' or 'deep'")
+    def forward(self, query: str, depth: Literal["standard", "deep"]) -> str:
 
         try:
             response = self.client.search(