get_rank_and_traffic_stats
Retrieve website ranking and traffic data from Bing Webmaster Tools to analyze search performance and identify optimization opportunities.
Instructions
Get overall ranking and traffic statistics.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_url | Yes |
Implementation Reference
- mcp_server_bwt/main.py:242-256 (handler)The handler function that executes the tool: fetches overall ranking and traffic statistics from Bing Webmaster API using the _make_request helper and adds MCP-compatible __type field.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:238-241 (registration)Registers the get_rank_and_traffic_stats tool with FastMCP using the @mcp.tool decorator, specifying name and description.@mcp.tool( name="get_rank_and_traffic_stats", description="Get overall ranking and traffic statistics.", )
- mcp_server_bwt/main.py:59-110 (helper)Helper method in BingWebmasterAPI class that performs HTTP requests to Bing API endpoints, handles authentication, OData responses, and errors. Used 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
- mcp_server_bwt/main.py:112-120 (helper)Helper method that adds the required __type field to API responses for MCP protocol compatibility. Called by the tool handler.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