What is OpenSearch Description Generator?
An OpenSearch description is an XML document that tells browsers how to search a website. When a browser detects the OpenSearch link tag, it offers to add the site's search as a search engine option. Users can then search the site directly from the browser address bar or search box without visiting the site first. Firefox, Edge, and some Chromium-based browsers support this feature.
quickAnswer
Generate an OpenSearch description XML file so browsers can add your site search as a search engine. Include a short name, search URL with {searchTerms} placeholder, and favicon URL. Add the link tag to your page head so browsers auto-discover the search plugin.
limitations
- Safari does not support OpenSearch. The feature works primarily in Firefox and Chromium-based browsers. Consider it a progressive enhancement rather than a core search feature.
- The OpenSearch 1.1 specification (2005) is old and has not been updated. The format is stable but lacks some modern search features like structured data integration.
- The XML file must be served with the correct Content-Type header (application/opensearchdescription+xml). Some static hosts may not serve custom content types for XML files.
How to use this tool
- Enter a short name (max 16 characters) for the search engine and a brief description.
- Provide the search URL template with {searchTerms} as the placeholder for the user's query.
- Add a favicon URL and optionally a suggestions URL for search autocomplete.
- Copy the XML to opensearch.xml and add the link tag to every page's head section.
What you can use it for
- Add site search to Firefox and Chromium-based browsers so users can search directly from the address bar.
- Create an OpenSearch plugin for a documentation site or knowledge base with a dedicated search page.
- Add search integration for a static site that uses a third-party search service like Algolia or a custom search endpoint.