Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| BING_WEBMASTER_API_KEY | Yes | Your Bing Webmaster Tools API key |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_sites | Retrieve all sites in the user's Bing Webmaster Tools account. Returns: List[Site]: List of sites associated with the account Raises: BingWebmasterError: If the API request fails |
| add_site | Add a new site to Bing Webmaster Tools. Args: site_url: The URL of the site to add Raises: BingWebmasterError: If the site cannot be added |
| verify_site | Attempt to verify ownership of a site. Args: site_url: The URL of the site to verify Returns: bool: True if verification was successful Raises: BingWebmasterError: If verification fails |
| remove_site | Remove a site from Bing Webmaster Tools. Args: site_url: The URL of the site to remove Raises: BingWebmasterError: If the site cannot be removed |
| get_site_roles | Get all roles assigned for a specific site. Args: site_url: The URL of the site include_all_subdomains: Whether to include roles for all subdomains Returns: List[SiteRole]: List of role assignments for the site Raises: BingWebmasterError: If the roles cannot be retrieved |
| add_site_roles | Delegate site access to a user. Args: site_url: The URL of your site delegated_url: The URL being delegated user_email: The email of the user to delegate access to authentication_code: The authentication code is_administrator: Whether the user should have administrator privileges is_read_only: Whether the user should have read-only access Raises: BingWebmasterError: If the role assignment fails |
| remove_site_role | Remove a user's site access. Args: site_url: The URL of the site site_role: The site role to remove Raises: BingWebmasterError: If the role cannot be removed |
| get_site_moves | Get site move information for a specific site. Args: site_url: The URL of the site Returns: List[SiteMoveSettings]: List of site move settings Raises: BingWebmasterError: If the site move information cannot be retrieved |
| submit_site_move | Submit a site move request. Args: site_url: The URL of the site settings: The site move settings containing move configuration Raises: BingWebmasterError: If the site move submission fails |
| submit_url | Submit a single URL for indexing. It is possible to submit only limited number of url. get_url_submission_quota should be called to determine how much urls can be submitted. Args: site_url: The URL of the site url: The specific URL to submit Raises: BingWebmasterError: If URL cannot be submitted |
| submit_url_batch | Submit multiple URLs for indexing in a single request. The max number of urls that can be submitted in a batch is 500 unless it exceeds the available quota. get_url_submission_quota should be called to determine how much urls can be submitted. Args: site_url: The URL of the site url_list: List of URLs to submit Raises: BingWebmasterError: If URLs cannot be submitted |
| submit_content | Submit content for a specific URL. Args: site_url: Site url E.g.: http://example.com url: Url to submit E.g.: http://example.com/url1.html http_message: HTTP message (base64 encoded) structured_data: Structured Data (base64 encoded) dynamic_serving: Device targeting (0-5). {none = 0, PC-laptop = 1, mobile = 2, AMP = 3, tablet = 4, non-visual browser = 5} Raises: BingWebmasterError: If content cannot be submitted |
| submit_feed | Submit a sitemap feed for indexing. Args: site_url: The URL of the site feed_url: The URL of the sitemap feed Raises: BingWebmasterError: If feed cannot be submitted |
| get_feeds | Get all sitemap feeds for a site. Args: site_url: The URL of the site Returns: List[Feed]: List of feed information Raises: BingWebmasterError: If feeds cannot be retrieved |
| get_feed_details | Get detailed information about a specific feed. Args: site_url: The URL of the site feed_url: The URL of the feed Returns: List[Feed]: Detailed feed information Raises: BingWebmasterError: If feed details cannot be retrieved |
| remove_feed | Remove a previously submitted sitemap feed. Args: site_url: The URL of the site feed_url: The URL of the feed to remove Raises: BingWebmasterError: If feed cannot be removed |
| get_url_submission_quota | Get information about URL submission quota and usage. Args: site_url: The URL of the site Returns: UrlSubmissionQuota: Current quota information Raises: BingWebmasterError: If quota information cannot be retrieved |
| get_content_submission_quota | Get information about content submission quota and usage. Args: site_url: The URL of the site Returns: ContentSubmissionQuota: Current quota information Raises: BingWebmasterError: If quota information cannot be retrieved |
| fetch_url | Request Bing to fetch a specific URL immediately. Args: site_url: The URL of the site url: The URL to fetch Raises: BingWebmasterError: If URL cannot be fetched |
| get_fetched_urls | Get a list of URLs that have been submitted for fetching. Args: site_url: The URL of the site Returns: List[FetchedUrl]: List of fetched URLs and their status Raises: BingWebmasterError: If fetched URLs cannot be retrieved |
| get_fetched_url_details | Get detailed information about a specific fetched URL. Args: site_url: The URL of the site url: The specific URL to get details for Returns: FetchedUrlDetails: Detailed information about the fetch status Raises: BingWebmasterError: If URL details cannot be retrieved |
| get_query_stats | Get detailed traffic statistics for top queries. Args: site_url: The URL of the site Returns: List[QueryStats]: List of statistics for top queries Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_query_traffic_stats | Get detailed traffic statistics for a specific query. Args: site_url: The URL of the site query: The search query to get statistics for Returns: List[RankAndTrafficStats]: List of traffic statistics for the query Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_query_page_stats | Get detailed traffic statistics for pages matching a specific query. Args: site_url: The URL of the site query: The search query to get statistics for Returns: List[QueryStats]: List of page statistics for the query Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_query_page_detail_stats | Get detailed statistics for a specific query and page combination. Args: site_url: The URL of the site query: The search query page: The specific page URL Returns: List[DetailedQueryStats]: List of detailed statistics Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_page_stats | Get detailed traffic statistics for top pages. Args: site_url: The URL of the site Returns: List[QueryStats]: List of query statistics for top pages Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_page_query_stats | Get detailed traffic statistics for a specific page. Args: site_url: The URL of the site page: The specific page URL to get statistics for Returns: List[QueryStats]: List of query statistics for the specified page Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_rank_and_traffic_stats | Get ranking and traffic statistics for a site. Args: site_url: The URL of the site Returns: List[RankAndTrafficStats]: List of ranking and traffic statistics Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_crawl_stats | Retrieve crawl statistics for a specific site within a date range. Args: site_url: The URL of the site Returns: List[CrawlStats]: List of daily crawl statistics Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_crawl_settings | Retrieve crawl settings for a specific site. Args: site_url: The URL of the site to get crawl settings for Returns: CrawlSettings: The current crawl settings for the site Raises: BingWebmasterError: If settings cannot be retrieved |
| save_crawl_settings | Save new crawl settings for a specific site. Args: site_url: The URL of the site crawl_settings: The new crawl settings to apply Raises: BingWebmasterError: If settings cannot be saved |
| get_crawl_issues | Get a list of URLs with crawl issues for a specific site. This helps identify pages that Bing's crawler had trouble accessing or processing. Args: site_url: The URL of the site Returns: List[UrlWithCrawlIssues]: List of URLs with their associated crawl issues Raises: BingWebmasterError: If issues cannot be retrieved |
| get_keyword | Get keyword impressions for a selected period. Args: query: The keyword query country: The country code language: The language code start_date: The start date of the period end_date: The end date of the period Returns: Optional[Keyword]: Keyword impression data, or None if no data available Raises: BingWebmasterError: If keyword data cannot be retrieved |
| get_keyword_stats | Retrieve keyword statistics for a specific query. Args: query: The keyword query country: The country code (i.e. gb) language: The language and country code (i.e. en-GB) Returns: List[KeywordStats]: List of keyword statistics Raises: BingWebmasterError: If statistics cannot be retrieved |
| get_related_keywords | Get keyword impressions for related keywords in the selected period. Args: query: The base keyword query country: The country code language: The language code start_date: The start date of the period end_date: The end date of the period Returns: List[Keyword]: List of related keywords and their impression data Raises: BingWebmasterError: If related keywords cannot be retrieved |
| get_link_counts | Retrieve link counts for a specific site. Args: site_url: The URL of the site page: The page number of results to retrieve Returns: LinkCounts: Summary of link counts Raises: BingWebmasterError: If link counts cannot be retrieved |
| get_url_links | Retrieve inbound links for a specific URL. Args: site_url: The URL of the site link: The specific URL to get inbound links for page: The page number of results to retrieve Returns: LinkDetails: Details about inbound links Raises: BingWebmasterError: If link details cannot be retrieved |
| get_deep_link | Get deep links for a specific algo URL. (Deprecated) Args: site_url: The URL of the site url: The specific URL to get deep links for Returns: List[DeepLink]: List of deep links Raises: BingWebmasterError: If deep links cannot be retrieved |
| get_deep_link_blocks | Get deep link blocks for a site. Args: site_url: The URL of the site Returns: List[DeepLinkBlock]: List of deep link blocks Raises: BingWebmasterError: If blocks cannot be retrieved |
| add_deep_link_block | Add a deep link block. Args: site_url: The URL of the site market: The market code search_url: The search URL deep_link_url: The deep link URL to block Raises: BingWebmasterError: If block cannot be added |
| remove_deep_link_block | Remove a deep link block. Args: site_url: The URL of the site market: The market code search_url: The search URL deep_link_url: The deep link URL to unblock Raises: BingWebmasterError: If block cannot be removed |
| update_deep_link | Update deep link weight. (Deprecated) Args: site_url: The URL of the site algo_url: The algo URL deep_link: The deep link URL weight: The new weight for the deep link Raises: BingWebmasterError: If deep link cannot be updated |
| get_deep_link_algo_urls | Get algo URLs with deep links. (Deprecated) Args: site_url: The URL of the site Returns: List[DeepLinkAlgoUrl]: List of algo URLs with deep links Raises: BingWebmasterError: If algo URLs cannot be retrieved |
| get_connected_pages | Get a list of pages connected to the site. Args: site_url: The URL of the site Returns: List[ConnectedSite]: List of connected sites Raises: BingWebmasterError: If connected pages cannot be retrieved |
| add_connected_page | Add a page which has a link to your website. Args: site_url: The URL of your site master_url: The URL of the page to be connected Raises: BingWebmasterError: If page cannot be connected |
| get_url_info | Retrieve detailed information for a specific URL. Args: site_url: The URL of the site url: The specific URL to get information for Returns: UrlInfo: Detailed information about the URL Raises: BingWebmasterError: If URL information cannot be retrieved |
| get_url_traffic_info | Get traffic details for a single page. Args: site_url: The URL of the site url: The specific URL to get traffic info for Returns: UrlTrafficInfo: Traffic information for the URL Raises: BingWebmasterError: If traffic information cannot be retrieved |
| get_children_url_info | Retrieve information for child URLs of a specific URL. Args: site_url: The URL of the site url: The parent URL to get child URL information for page: The page number of results to retrieve filter_properties: Properties to filter the results Returns: List[UrlInfo]: List of URL information for child URLs Raises: BingWebmasterError: If child URL information cannot be retrieved |
| get_children_url_traffic_info | Get traffic details for child URLs of a directory. Args: site_url: The URL of the site url: The URL of the directory page: The page number of results to retrieve Returns: List[UrlTrafficInfo]: List of traffic information for child URLs Raises: BingWebmasterError: If child traffic information cannot be retrieved |
| get_blocked_urls | Get a list of blocked pages/directories for a site. Args: site_url: The URL of the site Returns: List[BlockedUrl]: List of blocked URLs and their settings Raises: BingWebmasterError: If blocked URLs cannot be retrieved |
| add_blocked_url | Add a blocked URL to a site. Args: site_url: The URL of the site blocked_url: The URL to be blocked entity_type: The type of entity to block (Page or Directory) date: The date the URL was blocked (default: minimum datetime) Raises: BingWebmasterError: If URL cannot be blocked |
| remove_blocked_url | Remove a blocked URL from a site. Args: site_url: The URL of the site blocked_url: The URL to be unblocked entity_type: The type of entity to unblock (Page or Directory) date: The date the URL was blocked Raises: BingWebmasterError: If URL cannot be unblocked |
| get_active_page_preview_blocks | Get active page preview blocks for a site. Args: site_url: The URL of the site Returns: List[PagePreview]: List of active page preview blocks Raises: BingWebmasterError: If preview blocks cannot be retrieved |
| add_page_preview_block | Add a page preview block. Args: site_url: The URL of the site url: The URL to block from page preview reason: The reason for blocking the page preview Raises: BingWebmasterError: If preview block cannot be added |
| remove_page_preview_block | Remove a page preview block. Args: site_url: The URL of the site url: The URL to remove the page preview block from Raises: BingWebmasterError: If preview block cannot be removed |
| get_country_region_settings | Retrieve country/region settings for a specific site. Args: site_url: The URL of the site to get settings for Returns: List[CountryRegionSettings]: List of country/region settings Raises: BingWebmasterError: If settings cannot be retrieved |
| add_country_region_settings | Add country/region settings for a specific site. Args: site_url: The URL of the site settings: The country/region settings to add Raises: BingWebmasterError: If settings cannot be added |
| remove_country_region_settings | Remove country/region settings from a specific site. Args: site_url: The URL of the site settings: The country/region settings to remove Raises: BingWebmasterError: If settings cannot be removed |
| get_query_parameters | Get a list of URL normalization parameters for a site. URL parameters are used to identify which URL parameters should be considered for URL normalization (e.g., sorting, filtering parameters that don't change the content). Args: site_url: The URL of the site Returns: List[QueryParameter]: List of query parameters configuration Raises: BingWebmasterError: If parameters cannot be retrieved |
| add_query_parameter | Add a URL normalization parameter for a site. Args: site_url: The URL of the site query_parameter: The query parameter to add Raises: BingWebmasterError: If parameter cannot be added |
| remove_query_parameter | Remove a URL normalization parameter from a site. Args: site_url: The URL of the site query_parameter: The query parameter to remove Raises: BingWebmasterError: If parameter cannot be removed |
| enable_disable_query_parameter | Enable or disable a URL normalization parameter for a site. Args: site_url: The URL of the site query_parameter: The query parameter to enable/disable is_enabled: True to enable, False to disable Raises: BingWebmasterError: If parameter state cannot be updated |