feat: add examples and imporve ui

tdagent/tools/get_domain_information.py

@@ -325,39 +325,44 @@ def retrieve_ioc_from_threatfox(potentially_ioc: str) -> str:
 
 geo_location_tool = gr.Interface(
     fn=get_geolocation,
-    inputs=["text"],
-    outputs="json",
+    inputs=gr.Textbox(label="ip"),
+    outputs=gr.JSON(label="Geolocation of IP"),
     title="Domain Associated Geolocation Finder",
     description="Retrieves the geolocation associated to an input ip address",
     theme="default",
+    examples=["1.0.3.255", "59.34.7.3"],
 )
 
 dns_enumeration_tool = gr.Interface(
     fn=enumerate_dns,
-    inputs=["text"],
-    outputs="json",
+    inputs=gr.Textbox(label="domain"),
+    outputs=gr.JSON(label="DNS records"),
     title="DNS record enumerator of domains",
     description="Retrieves several dns record types for the input domain names",
     theme="default",
+    examples=["owasp.org", "nist.gov"],
 )
 
 scrap_subdomains_tool = gr.Interface(
     fn=scrap_subdomains_for_domain,
-    inputs=["text"],
-    outputs="json",
+    inputs=gr.Textbox(label="domain"),
+    outputs=gr.JSON(label="Subdomains managed by domain"),
     title="Subdomains Extractor of domains",
     description="Retrieves the subdomains for the input domain if they are common",
     theme="default",
+    examples=["github.com", "netacea.com"],
 )
 
 extractor_of_ioc_from_threatfox_tool = gr.Interface(
     fn=retrieve_ioc_from_threatfox,
-    inputs=["text"],
-    outputs="text",
+    inputs=gr.Textbox(label="IoC - url, domains or hash"),
+    outputs=gr.Text(label="Entity information as an IoC"),
     title="IoC information extractor associated to particular entities",
     description=(
         "If information as an Indicator of Compromise (IoC) exists "
         "for the input url, domain or hash, it retrieves it"
     ),
     theme="default",
+    examples=["advertipros.com", "dev.couplesparks.com"],
+    example_labels=["👾 IoC 1", "👾 IoC 2"],
 )

tdagent/tools/get_url_content.py

@@ -51,13 +51,16 @@ def get_url_http_content(
 
 gr_get_url_http_content = gr.Interface(
     fn=get_url_http_content,
-    inputs=["text", "text"],
-    outputs="text",
+    inputs=[gr.Textbox(label="url"), gr.Textbox(label="content type")],
+    outputs=gr.Text(label="content"),
     title="Get the content of a URL using an HTTP GET request.",
     description=(
         "Get the content of a URL in one of the specified content types."
         " The server may not honor the content type and if it fails the"
         " reason should also be returned with the corresponding HTTP"
-        " error code."
+        " error code. Be wary of retrieving the content of malicious urls."
     ),
+    examples=[
+        ["https://google.com", "html"],
+    ],
 )

tdagent/tools/query_abuse_ip_db.py

@@ -156,11 +156,13 @@ def query_abuseipdb(ip_address: str, days: int = 30) -> str:
 
 gr_query_abuseipdb = gr.Interface(
     fn=query_abuseipdb,
-    inputs=["text"],
-    outputs="text",
+    inputs=gr.Textbox(label="ip"),
+    outputs=gr.Text(label="Report on abusive behaviour"),
     title="AbuseIPDB IP Checker",
     description=(
         "Check if an IP address has been reported for abusive behavior"
         " using AbuseIP DB API"
     ),
+    examples=["5.252.155.14", "77.239.99.248"],
+    example_labels=["👾 Malicious IP 1", "👾 Malicious IP 2"],
 )

tdagent/tools/rdap.py

@@ -102,8 +102,9 @@ def query_rdap(  # noqa: PLR0911
 
 gr_query_rdap = gr.Interface(
     fn=query_rdap,
-    inputs=["text"],
-    outputs="json",
+    inputs=gr.Textbox(label="url or ip"),
+    outputs=gr.JSON(label="Report from RDAP"),
     title="Get RDAP information for a given URL.",
     description="Query a RDAP database to gather information about a url or domain.",
+    examples=["8.8.8.8", "pastebin.com"],
 )

tdagent/tools/retrieve_from_mitre_attack.py

@@ -42,11 +42,18 @@ def get_stix_object_of_attack_id(
 
 gr_get_stix_of_attack_id = gr.Interface(
     fn=get_stix_object_of_attack_id,
-    inputs=["text", "text"],
-    outputs="json",
+    inputs=[
+        gr.Textbox(label="Mitre technique ID"),
+        gr.Textbox(label="Mitre object type"),
+    ],
+    outputs=gr.JSON(label="Mitre report"),
     title="MITRE ATT&CK STIX information",
     description=(
         "Retrieves a specific STIX object identified by an ATT&CK ID across all ATT&CK"
         " matrices"
     ),
+    examples=[
+        ["T1568.002", "attack-pattern"],
+        ["M1042", "course-of-action"],
+    ],
 )

tdagent/tools/virus_total.py

@@ -69,8 +69,10 @@ Cache Status: Hit
 
 gr_virus_total_url_info = gr.Interface(
     fn=get_virus_total_url_info,
-    inputs=["text"],
-    outputs="text",
+    inputs=gr.Textbox(label="url"),
+    outputs=gr.Text(label="VirusTotal report"),
     title="VirusTotal URL Scanner",
     description="Get URL Info from VirusTotal URL Scanner. Scan URL is not available",
+    examples=["https://advertipros.com//?u=script", "https://google.com"],
+    example_labels=["👾 Malicious URL", "🧑‍💻 Benign URL"],
 )