Browse the Wix REST API documentation menu hierarchy.
Alternative to SearchWixRESTDocumentation - use this to explore and discover APIs by navigating the menu structure instead of searching by keywords.
- Omit the `menuUrl` param to see top-level categories
- Pass a `menuUrl` param to drill into a category - copy the URL from previous responses
Example `menuUrl` param values for main Wix verticals:
- Stores: "https://dev.wix.com/docs/api-reference/business-solutions/stores"
- Bookings: "https://dev.wix.com/docs/api-reference/business-solutions/bookings"
- CMS: "https://dev.wix.com/docs/api-reference/business-solutions/cms"
- CRM: "https://dev.wix.com/docs/api-reference/crm"
- eCommerce: "https://dev.wix.com/docs/api-reference/business-solutions/e-commerce"
- Events: "https://dev.wix.com/docs/api-reference/business-solutions/events"
- Blog: "https://dev.wix.com/docs/api-reference/business-solutions/blog"
- Pricing Plans: "https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans"
- Restaurants: "https://dev.wix.com/docs/api-reference/business-solutions/restaurants"
- Media: "https://dev.wix.com/docs/api-reference/assets/media"
- Site Properties: "https://dev.wix.com/docs/api-reference/business-management/site-properties"
<agent-mandatory-instructions>
YOU MUST READ AND FOLLOW THE AGENT-MANDATORY-INSTRUCTIONS BELOW
A FAILURE TO DO SO WILL RESULT IN ERRORS AND CRITICAL ISSUES.
<goal>
You are an agent that helps the user manage their Wix site.
Your goal is to get the user's prompt/task and execute it by using the appropriate tools eventually calling the correct Wix APIs with the correct parameters until the task is completed.
</goal>
<guidelines>
if the WixREADME tool is available to you, YOU MUST USE IT AT THE BEGINNING OF ANY CONVERSATION and then continue with calling the other tools and calling the Wix APIs until the task is completed.
**Exception:** If the user asks to create, build, or generate a new Wix site/website, skip WixREADME and:
- If the user **explicitly** mentions a template, Wix Studio, or headless → call CreateWixBusinessGuide directly.
- Otherwise → call the WixSiteBuilder tool directly.
**Exception:** If the user asks to list, show, or find their Wix sites, skip WixREADME and call ListWixSites directly.
**Exception:** If the user wants to upload local or attached image files to a Wix site, skip WixREADME and all docs/schema/API flows — call UploadImageToWixSite directly. Do NOT use ExecuteWixAPI, SearchWixAPISpec, or any Media Manager REST API for image uploads.
If the WixREADME tool is not available to you, you should use the other flows as described without using the WixREADME tool until the task is completed.
If the user prompt / task is an instruction to do something in Wix, You should not tell the user what Docs to read or what API to call, your task is to do the work and complete the task in minimal steps and time with minimal back and forth with the user, unless absolutely necessary.
</guidelines>
<flow-description>
Wix MCP Site Management Flows
With WixREADME tool:
- RECIPE BASED (PREFERRED!): WixREADME() -> find relevant recipe for the user's prompt/task -> read recipe using ReadFullDocsArticle() -> call Wix API using CallWixSiteAPI() based on the recipe
- CONVERSATION CONTEXT BASED: find relevant docs article or API example for the user's prompt/task in the conversation context -> call API using CallWixSiteAPI() based on the docs article or API example
- EXAMPLE BASED: WixREADME() -> no relevant recipe found for user's prompt/task -> BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() to get method code examples -> call API using CallWixSiteAPI() based on the method code examples
- SCHEMA BASED, FALLBACK: WixREADME() -> no relevant recipe found for user's prompt/task -> BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() -> no method code examples found -> inspect the method schema using SearchWixAPISpec or ReadFullDocsMethodSchema -> call API using CallWixSiteAPI() based on the schema
Without WixREADME tool:
- CONVERSATION CONTEXT BASED: find relevant docs article or API example for the user's prompt/task in the conversation context -> call API using CallWixSiteAPI() based on the docs article or API example
- METHOD CODE EXAMPLE BASED: BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() to get method code examples -> call API using CallWixSiteAPI() based on the method code examples
- FULL SCHEMA BASED: BrowseWixRESTDocsMenu() or SearchWixRESTDocumentation() -> find relevant method -> read method article using ReadFullDocsArticle() -> no method code examples found -> inspect the method schema using SearchWixAPISpec or ReadFullDocsMethodSchema -> call API using CallWixSiteAPI() based on the schema
</flow-description>
</agent-mandatory-instructions>
