feat: improves readibility

README.md

@@ -14,45 +14,45 @@ short_description: AI-driven TDAgent to automate threat analysis with MCP tools
 
 ---
 
-# TDAgentTools & TDAgent: Empowering Cybersecurity with Agentic AI
+# Welcome to **TDAgentTools & TDAgent**
 
-Welcome to TDAgentTools & TDAgent, our innovative proof of concept (PoC) crafted for the Agents-MCP Hackathon. Our initiatives focus on leveraging Agentic AI to enhance cybersecurity threat analysis, providing robust tools for data enrichment and strategic advice for incident handling.
+Our innovative proof of concept (PoC) crafted for the Agents-MCP Hackathon. Our initiatives focus on leveraging Agentic AI to enhance cybersecurity threat analysis, providing robust tools for data enrichment and strategic advice for incident handling.
 
 ## Team Introduction
 
 We are an AI-focused team within a company, dedicated to empowering other teams by implementing AI solutions. Our expertise lies in automating processes to enhance productivity and tackle complex tasks that AI excels in. Our hackathon team members include:
 
-- Pedro Completo Bento
-- Josep Pon Farreny
-- Sofia Jeronimo dos Santos
-- Rodrigo Dominguez Sanz
-- Miguel Rodin
+- **Pedro Completo Bento**
+- **Josep Pon Farreny**
+- **Sofia Jeronimo dos Santos**
+- **Rodrigo Dominguez Sanz**
+- **Miguel Rodin**
 
 ## Project Overview
 
-### Track 1: MCP Tool - TDAgentTools
+### Track 1: MCP Tool - **TDAgentTools**
 
-TDAgentTools serves as an MCP server built using Gradio, offering a wide array of cybersecurity intelligence tools. These tools enable users to augment their LLMs' capabilities by integrating with various publicly available cybersecurity intel resources. Our TDAgentTools are accessible via the following link: [TDAgentTools Space](https://huggingface.co/spaces/Agents-MCP-Hackathon/TDAgentTools).
+**TDAgentTools** serves as an MCP server built using Gradio, offering a wide array of cybersecurity intelligence tools. These tools enable users to augment their LLMs' capabilities by integrating with various publicly available cybersecurity intel resources. Our **TDAgentTools** are accessible via the following link: [TDAgentTools Space](https://huggingface.co/spaces/Agents-MCP-Hackathon/TDAgentTools).
 
 #### Available Tools:
-1. **TDAgentTools_get_url_http_content**: Retrieve URL content through an HTTP GET request.
-2. **TDAgentTools_query_abuseipdb**: Query AbuseIPDB to check if an IP is reported for abusive behavior.
-3. **TDAgentTools_query_rdap**: Gather information about internet resources such as domain names and IP addresses.
-4. **TDAgentTools_get_virus_total_url_info**: Fetch URL information using VirusTotal URL Scanner.
-5. **TDAgentTools_get_geolocation**: Obtain location details from an IP address.
-6. **TDAgentTools_enumerate_dns**: Access DNS configuration details for a given domain.
-7. **TDAgentTools_scrap_subdomains_for_domain**: Retrieve subdomains related to a domain.
-8. **TDAgentTools_retrieve_ioc_from_threatfox**: Get potential IoC information from ThreatFox.
-9. **TDAgentTools_get_stix_object_of_attack_id**: Access a STIX object using an ATT&CK ID.
-10. **TDAgentTools_lookup_user**: Seek user details from the Company User Lookup System.
-11. **TDAgentTools_lookup_cloud_account**: Investigate cloud account information.
-12. **TDAgentTools_send_email**: Simulate emailing from cert@company.com.
+1. ***TDAgentTools_get_url_http_content***: Retrieve URL content through an HTTP GET request.
+2. ***TDAgentTools_query_abuseipdb***: Query AbuseIPDB to check if an IP is reported for abusive behavior.
+3. ***TDAgentTools_query_rdap***: Gather information about internet resources such as domain names and IP addresses.
+4. ***TDAgentTools_get_virus_total_url_info***: Fetch URL information using VirusTotal URL Scanner.
+5. ***TDAgentTools_get_geolocation***: Obtain location details from an IP address.
+6. ***TDAgentTools_enumerate_dns***: Access DNS configuration details for a given domain.
+7. ***TDAgentTools_scrap_subdomains_for_domain***: Retrieve subdomains related to a domain.
+8. ***TDAgentTools_retrieve_ioc_from_threatfox***: Get potential IoC information from ThreatFox.
+9. ***TDAgentTools_get_stix_object_of_attack_id***: Access a STIX object using an ATT&CK ID.
+10. ***TDAgentTools_lookup_user***: Seek user details from the Company User Lookup System.
+11. ***TDAgentTools_lookup_cloud_account***: Investigate cloud account information.
+12. ***TDAgentTools_send_email***: Simulate emailing from cert@company.com.
 
-> **Note:** TDAgentTools rely on publicly provided APIs and some of which require API keys. If any of these API keys are revoked, certain tools may not function as intended.
+> **Note:** TDAgentTools rely on publicly provided APIs, and some of these require API keys. If any of these API keys are revoked, certain tools may not function as intended.
 
-### Track 3: Agentic Demo Showcase - TDAgent
+### Track 3: Agentic Demo Showcase - **TDAgent**
 
-TDAgent is an adaptive and interactive AI agent. This agent facilitates a dynamic AI experience, allowing users to switch the LLM used and adjust the system prompt to refine the agent’s behavior and objectives. It uses TDAgentTools to enrich threat data. Explore it here: [TDAgent Space](https://huggingface.co/spaces/Agents-MCP-Hackathon/TDAgent).
+**TDAgent** is an adaptive and interactive AI agent. This agent facilitates a dynamic AI experience, allowing users to switch the LLM used and adjust the system prompt to refine the agent’s behavior and objectives. It uses **TDAgentTools** to enrich threat data. Explore it here: [TDAgent Space](https://huggingface.co/spaces/Agents-MCP-Hackathon/TDAgent).
 
 #### Key Features:
 - **Intelligent API Interactions**: The agent autonomously interacts with APIs for data enrichment and analysis without explicit user guidance.
@@ -80,16 +80,14 @@ We aimed to:
 
 Our projects successfully demonstrated rapid prototyping with Gradio and Hugging Face Spaces, achieving all intended objectives while providing an engaging and rewarding experience for our team. This PoC shows the potential for future expansions and refinements in the realm of cybersecurity AI support!
 
+---
 
 # TDA Agent
 
-# Development setup
+## Development setup
 
 To start developing you need the following tools:
 
- * [uv](https://docs.astral.sh/uv/)
+- [uv](https://docs.astral.sh/uv/)
 
-To start, sync all the dependencies with `uv sync --all-groups`.
-Then, install the pre-commit hooks (`uv run pre-commit install`) to
-ensure that future commits comply with the bare minimum to keep
-code _readable_.
+To start, sync all the dependencies with `uv sync --all-groups`. Then, install the pre-commit hooks (`uv run pre-commit install`) to ensure that future commits comply with the bare minimum to keep code _readable_.