Usage

Once installed, mcp-server-webcrawl can leverage search and retrieval capabilities to pull your website crawl data as needed, using advanced filtering. Use it to help manage your website, as an on-demand resource database (marketing, SEO, etc.), or anything else.

The truth of the matter is, you don’t need to know the API behind the MCP server, as it is designed to be consumed by the LLM. It is, however, useful to understand for advanced use cases.

Available Tools

The API is supposed to stay out your way, and to a large degree it can be navigated autonomously by your MCP client. Sometimes, however, you may need to nudge the LLM to the correct field or search strategy. The following is the currect API interface for your reference.

webcrawl_sites

This tool retrieves a list of sites (project websites or crawl directories).

Parameter	Type	Required	Description
ids	array<int>	No	List of project IDs to retrieve. Leave empty for all projects.
fields	array<string>	No	List of additional fields to include beyond defaults (id, url). Empty list means default fields only. Options include created (ISO 8601), modified (ISO 8601), and norobots (str).

webcrawl_search

This tool searches for resources (webpages, CSS, images, etc.) across projects and retrieves specified fields.

Parameter	Type	Required	Description
sites	array<int>	No	Optional list of project IDs to filter search results to specific sites. In most scenarios, you’d filter to only one site.
query	string	No	Fulltext search query string. Leave empty to return all resources when filtering on other fields for better precision. Supports fulltext and boolean operators (AND, OR, NOT), quoted phrases, and suffix wildcards, but not prefix wildcards. See below for complete boolean and field search capabilities.
fields	array<string>	No	List of additional fields to include beyond defaults (modified, created). Empty list means default fields only. The content field can lead to large results and should be used with LIMIT.
sort	string	No	Sort order for results. Prefixed with + for ascending, - for descending. ? is a special option for random sort, useful in statistical sampling. Options include: +id, -id, +url, -url, +status, -status, ?.
limit	integer	No	Maximum number of results to return. Default is 20, max is 100.
offset	integer	No	Number of results to skip for pagination. Default is 0.
extras	array<string>	No	List of additional operations to perform with query. thumbnails: This creates small thumbnails that enable basic image recognition while keeping token output minimal. Only works for image (img) types. SVG format is not currently supported. markdown: Directly transforms the HTML content field into concise markdown, reducing token usage and improving readability for LLMs. This does not create a separate field but replaces the HTML in the content field with its markdown equivalent. Must be used with the content field in the fields parameter. <br> ‘snippets’: matches fulltext queries to contextual keyword usage within the content. When used without requesting the content field (or markdown extra), it can provide an efficient means of refining a search without pulling down the entire page content. Also great for rendering old school hit-highlighted results as a list, like Google search in 1999. Works with HTML, CSS, JS, or any text-based, crawled file.

Crawler Features Support

API support, by parameter, across crawler type.

Parameter	wget	WARC	InterroBot	Katana	SiteOne
Sites/ids	✔	✔	✔	✔	✔
Sites/fields	✔	✔	✔	✔	✔
Search/ids	✔	✔	✔	✔	✔
Search/sites	✔	✔	✔	✔	✔
Search/query	①	✔	✔	✔	①
Search/fields	②	✔	✔	✔	②
Search/sort	✔	✔	✔	✔	✔
Search/limit	✔	✔	✔	✔	✔
Search/offset	✔	✔	✔	✔	✔
Search/extras	✔	✔	✔	✔	✔

Crawler Field Support

API support, by field, across crawler type.

Parameter	wget	WARC	InterroBot	Katana	SiteOne
id	✔	✔	✔	✔	✔
url	✔	✔	✔	✔	✔
type	✔	✔	✔	✔	✔
status	③	✔	✔	✔	✔
size	✔	✔	✔	✔	✔
headers		✔	✔	✔
content	✔	✔	✔	✔	✔

①②③ wget (–mirror) does not index HTTP status beyond 200 OK (HTTP errors not saved to disk). wget and SiteOne crawler implementations do not support field searchable HTTP headers. When used in WARC mode (as opposed to simple mirror), wget is capable of collecting HTTP headers and status.

Crawlers have strengths and weaknesses, judge them on how well they fit your needs. Don’t worry too much about field support. You probably don’t need HTTP headers, except for specialized web-dev, honestly. They all support fulltext boolean search across the crawl data.

Boolean Search Syntax

The query engine supports field-specific (field: value) searches and complex boolean expressions. Fulltext is supported as a combination of the url, content, and headers fields.

While the API interface is designed to be consumed by the LLM directly, it can be helpful to familiarize yourself with the search syntax. Searches generated by the LLM are inspectable, but generally collapsed in the UI. If you need to see the query, expand the MCP collapsable.

Query Example	Description
privacy	fulltext single keyword match
“privacy policy”	fulltext match exact phrase
boundar*	fulltext wildcard matches results starting with boundar (boundary, boundaries)
id: 12345	id field matches a specific resource by ID
url: example.com/*	url field matches results with URL containing example.com/
type: html	type field matches for HTML pages only
status: 200	status field matches specific HTTP status codes (equal to 200)
status: >=400	status field matches specific HTTP status code (greater than or equal to 400)
content: h1	content field matches content (HTTP response body, often, but not always HTML)
headers: text/xml	headers field matches HTTP response headers
privacy AND policy	fulltext matches both
privacy OR policy	fulltext matches either
policy NOT privacy	fulltext matches policies not containing privacy
(login OR signin) AND form	fulltext matches fullext login or signin with form
type: html AND status: 200	fulltext matches only HTML pages with HTTP success

Field Search Definitions

Field search provides search precision, allowing you to specify which columns of the search index to filter. Rather than searching the entire content, you can restrict your query to specific attributes like URLs, headers, or content body. This approach improves efficiency when looking for specific attributes or patterns within crawl data.

Field	Description
id	database ID
url	resource URL
type	enumerated list of types (see types table)
status	HTTP response codes
headers	HTTP response headers
content	HTTP body—HTML, CSS, JS, and more

Content Types

Crawls contain a multitude of resource types beyond HTML pages. The type: field search allows filtering by broad content type groups, particularly useful when filtering images without complex extension queries. For example, you might search for type: html NOT content: login to find pages without “login,” or type: img to analyze image resources. The table below lists all supported content types in the search system.

Type	Description
html	webpages
iframe	iframes
img	web images
audio	web audio files
video	web video files
font	web font files
style	CSS stylesheets
script	JavaScript files
rss	RSS syndication feeds
text	plain text content
pdf	PDF files
doc	MS Word documents
other	uncategorized