get_ip_address_report

Instructions

Implementation Reference

• gti_mcp/tools/netloc.py:177-193 (handler)

  Handler function for get_ip_address_report tool. Accepts an IP address (IPv4 or IPv6), fetches a comprehensive report from Google Threat Intelligence API via vt_client using the utils.fetch_object helper, and returns a sanitized response.

  @server.tool()
  async def get_ip_address_report(ip_address: str, ctx: Context, api_key: str = None) -> typing.Dict[str, typing.Any]:
    """Get a comprehensive IP Address analysis report from Google Threat Intelligence.
  
    Args:
      ip_address (required): IP Address to analyze. It can be IPv4 or IPv6.
    Returns:
      Report with insights about the IP address.
    """
    async with vt_client(ctx, api_key=api_key) as client:
      res = await utils.fetch_object(
          client,
          "ip_addresses",
          "ip", ip_address,
          relationships=IP_KEY_RELATIONSHIPS,
          params={"exclude_attributes": "last_analysis_results"})
    return utils.sanitize_response(res)

• gti_mcp/tools/netloc.py:86-88 (schema)

  IP key relationships used by get_ip_address_report to fetch related associations alongside the IP address report.

  IP_KEY_RELATIONSHIPS = [
      "associations",
  ]

• gti_mcp/tools/netloc.py:177-177 (registration)

  Registration of get_ip_address_report as an MCP tool via the @server.tool() decorator on the handler function.

  @server.tool()

• gti_mcp/utils.py:29-84 (helper)

  Helper function used by get_ip_address_report to fetch the IP address object from the VT API with relationships and parameters.

  async def fetch_object(
      vt_client: vt.Client,
      resource_collection_type: str,
      resource_type: str,
      resource_id: str,
      attributes: list[str] | None = None,
      relationships: list[str] | None = None,
      params: dict[str, typing.Any] | None = None):
    """Fetches objects from Google Threat Intelligence API."""
    logging.info(
        f"Fetching comprehensive {resource_collection_type} "
        f"report for id: {resource_id}")
    
    params = {k: v for k, v in params.items()} if params else {}
  
    # Retrieve a selection of object attributes and/or relationships.
    if attributes:
      params["attributes"] = ",".join(attributes)
    if relationships:
      params["relationships"] = ",".join(relationships)
  
    try:
      obj = await vt_client.get_object_async(
          f"/{resource_collection_type}/{resource_id}", params=params)
  
      if obj.error:
        logging.error(
            f"Error fetching main {resource_type} report for {resource_id}: {obj.error}"
        )
        return {
            "error": f"Failed to get main {resource_type} report: {obj.error}",
            # "details": report.get("details"),
        }
    except vt.error.APIError as e:
      logging.warning(
          f"VirusTotal API Error fetching {resource_type} {resource_id}: {e.code} - {e.message}"
      )
      return {
          "error": f"VirusTotal API Error: {e.code} - {e.message}",
          "details": f"The requested {resource_type} '{resource_id}' could not be found or there was an issue with the API request."
      }
    except Exception as e:
      logging.exception(
          f"Unexpected error fetching {resource_type} {resource_id}: {e}"
      )
      return {"error": "An unexpected internal error occurred."}
  
    # Build response.
    obj_dict = obj.to_dict()
    obj_dict['id'] = obj.id
    if 'aggregations' in obj_dict['attributes']:
      del obj_dict['attributes']['aggregations']
  
    logging.info(
        f"Successfully generated concise threat summary for id: {resource_id}")
    return obj_dict

• gti_mcp/utils.py:119-138 (helper)

  Helper used by get_ip_address_report to clean up the response by recursively removing empty dicts and lists.

  def sanitize_response(data: typing.Any) -> typing.Any:
    """Removes empty dictionaries and lists recursively from a response."""
    if isinstance(data, dict):
      sanitized_dict = {}
      for key, value in data.items():
        sanitized_value = sanitize_response(value)
        if sanitized_value is not None:
          sanitized_dict[key] = sanitized_value
      return sanitized_dict
    elif isinstance(data, list):
      sanitized_list = []
      for item in data:
        sanitized_item = sanitize_response(item)
        if sanitized_item is not None:
          sanitized_list.append(sanitized_item)
      return sanitized_list
    elif isinstance(data, str):
      return data if data else None
    else:
      return data