get_rank_and_traffic_stats

Instructions

Implementation Reference

• mcp_server_bwt/main.py:238-256 (handler)

  The tool handler function get_rank_and_traffic_stats, decorated with @mcp.tool for registration. It takes a site_url, makes an API request to GetRankAndTrafficStats endpoint via the BingWebmasterAPI client, and returns the stats with type field ensured for MCP compatibility.

  @mcp.tool(
      name="get_rank_and_traffic_stats",
      description="Get overall ranking and traffic statistics.",
  )
  async def get_rank_and_traffic_stats(
      site_url: Annotated[str, "The URL of the site"]
  ) -> Dict[str, Any]:
      """
      Get overall ranking and traffic statistics.
  
      Args:
          site_url: The URL of the site
  
      Returns:
          Overall site statistics
      """
      async with api:
          stats = await api._make_request(f"GetRankAndTrafficStats?siteUrl={site_url}")
          return api._ensure_type_field(stats, "RankAndTrafficStats")

• mcp_server_bwt/main.py:112-121 (helper)

  Helper method _ensure_type_field used in the tool to add __type metadata to API responses for MCP compatibility.

  def _ensure_type_field(self, data: Any, type_name: str) -> Any:
      """Ensure __type field is present for MCP compatibility."""
      if isinstance(data, list):
          for item in data:
              if isinstance(item, dict) and "__type" not in item:
                  item["__type"] = f"{type_name}:#Microsoft.Bing.Webmaster.Api"
      elif isinstance(data, dict) and "__type" not in data:
          data["__type"] = f"{type_name}:#Microsoft.Bing.Webmaster.Api"
      return data

• mcp_server_bwt/main.py:59-111 (helper)

  Core helper method _make_request in BingWebmasterAPI class that performs HTTP requests to Bing Webmaster Tools API, handles OData responses, and is called by the tool handler.

  async def _make_request(
      self,
      endpoint: str,
      method: str = "GET",
      json_data: Optional[Dict[str, Any]] = None,
      params: Optional[Dict[str, Any]] = None,
  ) -> Any:
      """Make a request to the Bing API and handle OData responses."""
      if not self.client:
          raise RuntimeError(
              "API client not initialized. Use 'async with api:' context manager."
          )
  
      headers = {"Content-Type": "application/json; charset=utf-8"}
  
      # Build URL with API key
      if "?" in endpoint:
          url = f"{self.base_url}/{endpoint}&apikey={self.api_key}"
      else:
          url = f"{self.base_url}/{endpoint}?apikey={self.api_key}"
  
      # Add additional parameters if provided
      if params:
          for key, value in params.items():
              url += f"&{key}={value}"
  
      try:
          if method == "GET":
              response = await self.client.get(url, headers=headers)
          else:
              response = await self.client.request(
                  method, url, headers=headers, json=json_data
              )
  
          if response.status_code != 200:
              error_text = response.text
              logger.error(f"API error {response.status_code}: {error_text}")
              raise Exception(f"API error {response.status_code}: {error_text}")
  
          data = response.json()
  
          # Handle OData response format
          if "d" in data:
              return data["d"]
          return data
  
      except httpx.TimeoutException:
          logger.error(f"Request timeout for {endpoint}")
          raise Exception("Request timed out")
      except Exception as e:
          logger.error(f"Request failed: {str(e)}")
          raise