@wix/mcp 1.0.0 → 1.0.2

package/build/docs/long-content.d.ts

@@ -0,0 +1 @@
+export declare const LONG_KB_CONTENT = "# Method name:\n\ncrm.contacts.queryContacts(options: QueryContactsOptions)\n\n# Method Link:\n\nhttps://dev.wix.com/docs/sdk/backend-modules/crm/contacts/query-contacts\n\n# Method Description:\n\nCreates a query to retrieve a list of contacts.\n\nThe `queryContacts()` function builds a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object.\n\nThe returned object contains the query definition, which is typically used to run the query using the `find()` function.\n\nYou can refine the query by chaining `ContactsQueryBuilder` functions onto the query. `ContactsQueryBuilder` functions enable you to sort, filter, and control the results `queryContacts()` returns.\n\n`queryContacts()` runs with these `ContactsQueryBuilder` defaults, which you can override:\n\n- `skip(0)`\n- `limit(50)`\n- `descending(\"_createdDate\")`\n\nThe functions that are chained to `queryContacts()` are applied in the order they are called. For example, if you apply `ascending('info.company')` and then `descending('info.name.last')`, the results are sorted first by the company name, and then, if there are multiple results with the same company, the items are sorted by last name.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists)|\n|`_createdDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le)|\n|`lastActivity.activityDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`primaryInfo.email`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`primaryInfo.phone`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with)|\n|`info.name.first`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.name.last`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.company`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.jobTitle`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.birthdate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.locale`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists)|\n\n# Method Permissions:\n\n- Manage Events\n- Read Contacts\n- Read Members and Contacts - all read permissions\n- Manage Restaurants - all permissions\n- Manage Contacts\n- Set Up Automations\n- Manage Members and Contacts - all permissions\n\n# Method Permissions Scopes IDs:\n\n- SCOPE.EVENTS.MANAGE-EVENTS\n- SCOPE.DC-CONTACTS.READ-CONTACTS\n- SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n- SCOPE.RESTAURANTS.MEGA-SCOPES\n- SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n- SCOPE.CRM.SETUP-AUTOMATIONS\n- SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n\n# Method Schema Summary:\n\n# API Method Summary: `queryContacts`\n\n## Method Signature\n```javascript\ncrm.contacts.queryContacts(options)\n```\n\n## Description\nThe `queryContacts()` method creates a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object. This object allows for further refinement of the query through chaining methods to sort, filter, and control the results. The default settings for the query are:\n- `skip(0)`\n- `limit(50)`\n- `descending(\"_createdDate\")`\n\n## Parameters\n- **options**: `QueryContactsOptions`\n  - Description: Options for querying contacts.\n\n## Return Type\n- **REFERENCE<ContactsQueryBuilder>**: The method returns a `ContactsQueryBuilder` object that can be used to refine the query further.\n\n## Supported Filters & Sorting\nThe following properties can be used for filtering and sorting, along with their supported functions:\n\n| Property                     | Supported Functions                                                                                      |\n|------------------------------|---------------------------------------------------------------------------------------------------------|\n| `_id`                        | `eq()`, `ne()`, `in()`, `exists()`                                                                      |\n| `_createdDate`              | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`, `ascending()`, `descending()`                          |\n| `_updatedDate`              | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`                                                          |\n| `lastActivity.activityDate`  | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`, `ascending()`, `descending()`                          |\n| `primaryInfo.email`         | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `primaryInfo.phone`         | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`                                                    |\n| `info.name.first`           | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.name.last`            | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.company`              | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.jobTitle`             | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.birthdate`            | `eq()`, `ne()`, `ascending()`, `descending()`                                                           |\n| `info.locale`               | `eq()`, `ne()`, `in()`, `exists()`                                                                      |\n\n## Enum Properties\nThe following properties have limited allowed values (enums):\n\n- **lastActivity.activityType**: \n  - Valid values: `ARENA_NEW_LEAD`, `BOOKINGS_APPOINTMENT`, `CASHIER_BUTTON_PURCHASE`, `CONTACT_CREATED`, `CONTACT_MERGED`, `ECOM_CART_ABANDON`, `ECOM_CHECKOUT_BUYER`, `ECOM_PURCHASE`, `EVENTS_RSVP`, `FORM_SUBMITTED`, `GENERAL`, `HOTELS_CANCEL`, `HOTELS_CONFIRMATION`, `HOTELS_PURCHASE`, `HOTELS_RESERVATION`, `INBOX_FORM_SUBMITTED`, `INBOX_MESSAGE_FROM_CUSTOMER`, `INBOX_MESSAGE_TO_CUSTOMER`, `INBOX_PAYMENT_REQUEST_PAID`, `INVOICE_OVERDUE`, `INVOICE_PAY`, `MEMBER_LOGIN`, `MEMBER_REGISTER`, `MEMBER_STATUS_CHANGED`, `NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED`, `NEWSLETTER_SUBSCRIPTION_NOT_SET`, `NEWSLETTER_SUBSCRIPTION_PENDING`, `NEWSLETTER_SUBSCRIPTION_SUBSCRIBE`, `NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE`, `PHONE_SUBSCRIPTION_NOT_SET`, `PHONE_SUBSCRIPTION_PENDING`, `PHONE_SUBSCRIPTION_SUBSCRIBE`, `PHONE_SUBSCRIPTION_UNSUBSCRIBE`, `PRICE_QUOTE_ACCEPT`, `PRICE_QUOTE_EXPIRE`, `RESTAURANTS_ORDER`, `RESTAURANTS_RESERVATION`, `SHOUTOUT_CLICK`, `SHOUTOUT_OPEN`, `VIDEO_PURCHASE`, `VIDEO_RENT`\n\n- **primaryEmail.deliverabilityStatus**: \n  - Valid values: `BOUNCED`, `INACTIVE`, `NOT_SET`, `SPAM_COMPLAINT`, `VALID`\n\n- **primaryEmail.subscriptionStatus**: \n  - Valid values: `NOT_SET`, `NO_SUBSCRIPTION_STATUS`, `PENDING`, `SUBSCRIBED`, `UNSUBSCRIBED`\n\n- **primaryPhone.subscriptionStatus**: \n  - Valid values: `NOT_SET`, `NO_SUBSCRIPTION_STATUS`\n\n- **info.emails.items[].tag**: \n  - Valid values: `HOME`, `MAIN`, `UNTAGGED`, `WORK`\n\n- **info.phones.items[].tag**: \n  - Valid values: `FAX`, `HOME`, `MAIN`, `MOBILE`, `UNTAGGED`, `WORK`\n\n- **items[].info.addresses.items[].tag**: \n  - Valid values: `BILLING`, `HOME`, `SHIPPING`, `UNTAGGED`, `WORK`\n\n**Note**: Ensure to use the correct enum values when filtering or sorting based on these properties. \n\n## Possible Errors\nThe following errors may occur when using this method:\n- **400 INVALID_ARGUMENT**: Various application codes indicating unsupported filter value types, unsupported filter values, unsupported filter operators, unsupported filter fields, malformed filters, illegal limits, or unsupported sort fields.\n\n# Method Code Examples:\n\n## queryContacts\n\n```javascript\nimport { contacts } from '@wix/crm';\n\nasync function queryContacts() {\n  const { items } = await contacts.queryContacts().find();\n};\n```\n\n\n\n## default\n\n```javascript\ntry {\n      const { items } = await contacts.queryContacts().find();\n      return items;\n    } catch (error) {\n      console.error(error);\n      throw error;\n   }\n````";

package/build/docs/long-content.js

@@ -0,0 +1 @@
+export const LONG_KB_CONTENT = "# Method name:\n\ncrm.contacts.queryContacts(options: QueryContactsOptions)\n\n# Method Link:\n\nhttps://dev.wix.com/docs/sdk/backend-modules/crm/contacts/query-contacts\n\n# Method Description:\n\nCreates a query to retrieve a list of contacts.\n\nThe `queryContacts()` function builds a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object.\n\nThe returned object contains the query definition, which is typically used to run the query using the `find()` function.\n\nYou can refine the query by chaining `ContactsQueryBuilder` functions onto the query. `ContactsQueryBuilder` functions enable you to sort, filter, and control the results `queryContacts()` returns.\n\n`queryContacts()` runs with these `ContactsQueryBuilder` defaults, which you can override:\n\n- `skip(0)`\n- `limit(50)`\n- `descending(\"_createdDate\")`\n\nThe functions that are chained to `queryContacts()` are applied in the order they are called. For example, if you apply `ascending('info.company')` and then `descending('info.name.last')`, the results are sorted first by the company name, and then, if there are multiple results with the same company, the items are sorted by last name.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists)|\n|`_createdDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le)|\n|`lastActivity.activityDate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`gt()`](/contacts-query-builder/gt),[`lt()`](/contacts-query-builder/lt),[`ge()`](/contacts-query-builder/ge),[`le()`](/contacts-query-builder/le),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`primaryInfo.email`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`primaryInfo.phone`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with)|\n|`info.name.first`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.name.last`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.company`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.jobTitle`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists),[`startsWith()`](/contacts-query-builder/starts-with),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.birthdate`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`ascending()`](/contacts-query-builder/ascending),[`descending()`](/contacts-query-builder/descending)|\n|`info.locale`|[`eq()`](/contacts-query-builder/eq),[`ne()`](/contacts-query-builder/ne),[`in()`](/contacts-query-builder/in),[`exists()`](/contacts-query-builder/exists)|\n\n# Method Permissions:\n\n- Manage Events\n- Read Contacts\n- Read Members and Contacts - all read permissions\n- Manage Restaurants - all permissions\n- Manage Contacts\n- Set Up Automations\n- Manage Members and Contacts - all permissions\n\n# Method Permissions Scopes IDs:\n\n- SCOPE.EVENTS.MANAGE-EVENTS\n- SCOPE.DC-CONTACTS.READ-CONTACTS\n- SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS\n- SCOPE.RESTAURANTS.MEGA-SCOPES\n- SCOPE.DC-CONTACTS.MANAGE-CONTACTS\n- SCOPE.CRM.SETUP-AUTOMATIONS\n- SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS\n\n# Method Schema Summary:\n\n# API Method Summary: `queryContacts`\n\n## Method Signature\n```javascript\ncrm.contacts.queryContacts(options)\n```\n\n## Description\nThe `queryContacts()` method creates a query to retrieve a list of contacts and returns a `ContactsQueryBuilder` object. This object allows for further refinement of the query through chaining methods to sort, filter, and control the results. The default settings for the query are:\n- `skip(0)`\n- `limit(50)`\n- `descending(\"_createdDate\")`\n\n## Parameters\n- **options**: `QueryContactsOptions`\n  - Description: Options for querying contacts.\n\n## Return Type\n- **REFERENCE<ContactsQueryBuilder>**: The method returns a `ContactsQueryBuilder` object that can be used to refine the query further.\n\n## Supported Filters & Sorting\nThe following properties can be used for filtering and sorting, along with their supported functions:\n\n| Property                     | Supported Functions                                                                                      |\n|------------------------------|---------------------------------------------------------------------------------------------------------|\n| `_id`                        | `eq()`, `ne()`, `in()`, `exists()`                                                                      |\n| `_createdDate`              | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`, `ascending()`, `descending()`                          |\n| `_updatedDate`              | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`                                                          |\n| `lastActivity.activityDate`  | `eq()`, `ne()`, `gt()`, `lt()`, `ge()`, `le()`, `ascending()`, `descending()`                          |\n| `primaryInfo.email`         | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `primaryInfo.phone`         | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`                                                    |\n| `info.name.first`           | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.name.last`            | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.company`              | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.jobTitle`             | `eq()`, `ne()`, `in()`, `exists()`, `startsWith()`, `ascending()`, `descending()`                      |\n| `info.birthdate`            | `eq()`, `ne()`, `ascending()`, `descending()`                                                           |\n| `info.locale`               | `eq()`, `ne()`, `in()`, `exists()`                                                                      |\n\n## Enum Properties\nThe following properties have limited allowed values (enums):\n\n- **lastActivity.activityType**: \n  - Valid values: `ARENA_NEW_LEAD`, `BOOKINGS_APPOINTMENT`, `CASHIER_BUTTON_PURCHASE`, `CONTACT_CREATED`, `CONTACT_MERGED`, `ECOM_CART_ABANDON`, `ECOM_CHECKOUT_BUYER`, `ECOM_PURCHASE`, `EVENTS_RSVP`, `FORM_SUBMITTED`, `GENERAL`, `HOTELS_CANCEL`, `HOTELS_CONFIRMATION`, `HOTELS_PURCHASE`, `HOTELS_RESERVATION`, `INBOX_FORM_SUBMITTED`, `INBOX_MESSAGE_FROM_CUSTOMER`, `INBOX_MESSAGE_TO_CUSTOMER`, `INBOX_PAYMENT_REQUEST_PAID`, `INVOICE_OVERDUE`, `INVOICE_PAY`, `MEMBER_LOGIN`, `MEMBER_REGISTER`, `MEMBER_STATUS_CHANGED`, `NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED`, `NEWSLETTER_SUBSCRIPTION_NOT_SET`, `NEWSLETTER_SUBSCRIPTION_PENDING`, `NEWSLETTER_SUBSCRIPTION_SUBSCRIBE`, `NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE`, `PHONE_SUBSCRIPTION_NOT_SET`, `PHONE_SUBSCRIPTION_PENDING`, `PHONE_SUBSCRIPTION_SUBSCRIBE`, `PHONE_SUBSCRIPTION_UNSUBSCRIBE`, `PRICE_QUOTE_ACCEPT`, `PRICE_QUOTE_EXPIRE`, `RESTAURANTS_ORDER`, `RESTAURANTS_RESERVATION`, `SHOUTOUT_CLICK`, `SHOUTOUT_OPEN`, `VIDEO_PURCHASE`, `VIDEO_RENT`\n\n- **primaryEmail.deliverabilityStatus**: \n  - Valid values: `BOUNCED`, `INACTIVE`, `NOT_SET`, `SPAM_COMPLAINT`, `VALID`\n\n- **primaryEmail.subscriptionStatus**: \n  - Valid values: `NOT_SET`, `NO_SUBSCRIPTION_STATUS`, `PENDING`, `SUBSCRIBED`, `UNSUBSCRIBED`\n\n- **primaryPhone.subscriptionStatus**: \n  - Valid values: `NOT_SET`, `NO_SUBSCRIPTION_STATUS`\n\n- **info.emails.items[].tag**: \n  - Valid values: `HOME`, `MAIN`, `UNTAGGED`, `WORK`\n\n- **info.phones.items[].tag**: \n  - Valid values: `FAX`, `HOME`, `MAIN`, `MOBILE`, `UNTAGGED`, `WORK`\n\n- **items[].info.addresses.items[].tag**: \n  - Valid values: `BILLING`, `HOME`, `SHIPPING`, `UNTAGGED`, `WORK`\n\n**Note**: Ensure to use the correct enum values when filtering or sorting based on these properties. \n\n## Possible Errors\nThe following errors may occur when using this method:\n- **400 INVALID_ARGUMENT**: Various application codes indicating unsupported filter value types, unsupported filter values, unsupported filter operators, unsupported filter fields, malformed filters, illegal limits, or unsupported sort fields.\n\n# Method Code Examples:\n\n## queryContacts\n\n```javascript\nimport { contacts } from '@wix/crm';\n\nasync function queryContacts() {\n  const { items } = await contacts.queryContacts().find();\n};\n```\n\n\n\n## default\n\n```javascript\ntry {\n      const { items } = await contacts.queryContacts().find();\n      return items;\n    } catch (error) {\n      console.error(error);\n      throw error;\n   }\n````";

package/build/docs/semanticSearch.d.ts

@@ -0,0 +1,10 @@
+import type { DocsTool } from './docs.js';
+export declare const MAX_CONTENT_LENGTH = 10000;
+export declare const DEFAULT_MAX_RESULTS = 10;
+export declare const runSemanticSearchAndFormat: ({ toolName, toolParams, maxResults, rerank, linesInEachResult }: {
+    toolName: DocsTool;
+    toolParams: Record<string, string>;
+    maxResults?: number;
+    rerank?: boolean;
+    linesInEachResult?: number | undefined;
+}) => Promise<string>;

package/build/docs/semanticSearch.js

@@ -1,5 +1,6 @@
 import { logger } from '../logger.js';
-const MAX_CONTENT_LENGTH = 10000;
+export const MAX_CONTENT_LENGTH = 10000;
+export const DEFAULT_MAX_RESULTS = 10;
 const runSemanticSearch = async (toolName, toolParams, maxResults = 20, rerank = false) => {
     const startTime = new Date().getTime();
     const url = new URL(`https://www.wixapis.com/mcp-docs-search/v1/search?maxResults=${maxResults}&rerank=${rerank}`);
@@ -7,9 +8,12 @@ const runSemanticSearch = async (toolName, toolParams, maxResults = 20, rerank =
         url.searchParams.append('kbName', 'SDK_SCHEMAS_KB_ID');
         url.searchParams.append('kbName', 'SDK_DOCS_KB_ID');
     }
-    else if (toolName === 'REST') {
-        url.searchParams.append('kbName', 'REST_METHODS_KB_ID');
+    else if (toolName === 'REST' || toolName === 'BUSINESS_SOLUTIONS') {
+        if (toolName === 'REST') {
+            url.searchParams.append('kbName', 'REST_METHODS_KB_ID');
+        }
         url.searchParams.append('kbName', 'REST_DOCS_KB_ID');
+        url.searchParams.append('kbName', 'MCP_REST_RECIPES_KB_ID');
     }
     else if (toolName === 'WDS') {
         url.searchParams.append('kbName', 'WDS_DOCS_KB_ID');
@@ -28,8 +32,7 @@ const runSemanticSearch = async (toolName, toolParams, maxResults = 20, rerank =
         headers: {
             'Content-Type': 'application/json',
             'x-time-budget': '180000',
-            'x-wix-time-budget': '180000',
-            Cookie: process.env.WIX_COOKIE || ''
+            'x-wix-time-budget': '180000'
         }
     });
     if (!response.ok) {
@@ -52,7 +55,7 @@ const getContentFromChunkedContent = (chunkedContent) => {
     }
     return content;
 };
-const formatResultsContent = (resultsFromKbs, maxResults) => {
+const formatResultsContent = (resultsFromKbs, maxResults, linesInEachResult = undefined) => {
     // First, take the results from all KBs and sort them by overallMatchScore
     const allResults = Object.entries(resultsFromKbs)
         .map(([, { results }]) => results)
@@ -65,11 +68,29 @@ const formatResultsContent = (resultsFromKbs, maxResults) => {
     const topResults = sortedResults.slice(0, maxResults);
     // Concatenate the content of the top results
     const concatenatedContent = topResults
+        .map((result) => {
+        let newContent = result.entry.content;
+        if (linesInEachResult) {
+            const totalLines = newContent.split('\n').length;
+            const linesToTake = Math.min(linesInEachResult, totalLines);
+            newContent = newContent.split('\n').slice(0, linesToTake).join('\n');
+            const moreLines = totalLines - linesToTake;
+            const moreLinesText = moreLines > 0 ? `\n\n... ${moreLines} more lines ...` : '';
+            newContent = `${newContent}${moreLinesText}`;
+        }
+        return {
+            ...result,
+            entry: {
+                ...result.entry,
+                content: newContent
+            }
+        };
+    })
         .map((result) => {
         const content = result.entry.content;
         const chunkedContent = result.entry.chunkedContent;
         if (content.length > MAX_CONTENT_LENGTH) {
-            logger.log(`Content is too long, using first chunk`, {
+            logger.log(`Content is too long, using chunked content`, {
                 contentLength: content.length,
                 chunkedContentLength: chunkedContent.length
             });
@@ -80,7 +101,8 @@ const formatResultsContent = (resultsFromKbs, maxResults) => {
         .join('\n\n---\n\n');
     return concatenatedContent;
 };
-export const runSemanticSearchAndFormat = async (toolName, toolParams, maxResults = 20, rerank = false) => {
+export const runSemanticSearchAndFormat = async ({ toolName, toolParams, maxResults = DEFAULT_MAX_RESULTS, rerank, linesInEachResult }) => {
     const results = await runSemanticSearch(toolName, toolParams, maxResults, rerank);
-    return formatResultsContent(results, Math.min(maxResults, 10));
+    const maxResultsToUse = Math.min(maxResults, DEFAULT_MAX_RESULTS);
+    return formatResultsContent(results, maxResultsToUse, linesInEachResult);
 };

package/build/docs/semanticSearch.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/docs/semanticSearch.test.js

@@ -1,12 +1,13 @@
 import { describe, test, expect, beforeEach, vi, afterAll } from 'vitest';
-import { runSemanticSearchAndFormat } from './semanticSearch.js';
+import { DEFAULT_MAX_RESULTS, runSemanticSearchAndFormat } from './semanticSearch.js';
+import { LONG_KB_CONTENT } from './long-content.js';
 const sampleSearchResponse = {
     results: {
         SDK_DOCS_KB_ID: {
             results: [
                 {
                     entry: {
-                        content: 'SDK Documentation content 1'
+                        content: 'SDK Documentation content 1\nline 2\nline 3'
                     },
                     scoresInfo: {
                         overallMatchScore: 0.95
@@ -19,6 +20,15 @@ const sampleSearchResponse = {
                     scoresInfo: {
                         overallMatchScore: 0.85
                     }
+                },
+                {
+                    entry: {
+                        content: LONG_KB_CONTENT,
+                        chunkedContent: ['some-chunked-content']
+                    },
+                    scoresInfo: {
+                        overallMatchScore: 0.83
+                    }
                 }
             ]
         },
@@ -45,6 +55,18 @@ const sampleSearchResponse = {
                     }
                 }
             ]
+        },
+        MCP_REST_RECIPES_KB_ID: {
+            results: [
+                {
+                    entry: {
+                        content: 'Build Apps content 1'
+                    },
+                    scoresInfo: {
+                        overallMatchScore: 0.92
+                    }
+                }
+            ]
         }
     }
 };
@@ -109,13 +131,16 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => sdkResponse
         });
-        const result = await runSemanticSearchAndFormat('SDK', {
-            searchTerm: 'wix-data query'
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'SDK',
+            toolParams: {
+                searchTerm: 'wix-data query'
+            }
         });
         expect(fetchMock).toHaveBeenCalledTimes(1);
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('mcp-docs-search/v1/search');
-        expect(url).toContain('maxResults=20');
+        expect(url).toContain(`maxResults=${DEFAULT_MAX_RESULTS}`);
         expect(url).toContain('rerank=false');
         expect(url).toContain('kbName=SDK_SCHEMAS_KB_ID');
         expect(url).toContain('kbName=SDK_DOCS_KB_ID');
@@ -157,15 +182,54 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => restResponse
         });
-        const result = await runSemanticSearchAndFormat('REST', {
-            searchTerm: 'create collection'
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'REST',
+            toolParams: {
+                searchTerm: 'create collection'
+            }
         });
         expect(fetchMock).toHaveBeenCalledTimes(1);
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('kbName=REST_METHODS_KB_ID');
         expect(url).toContain('kbName=REST_DOCS_KB_ID');
+        expect(url).toContain('kbName=MCP_REST_RECIPES_KB_ID');
         expect(result).toBe('REST Methods content\n\n---\n\nREST Documentation content');
     });
+    test('performs BUSINESS_SOLUTIONS semantic search successfully', async () => {
+        const restResponse = {
+            results: {
+                REST_DOCS_KB_ID: {
+                    results: [
+                        {
+                            entry: {
+                                content: 'REST Documentation content'
+                            },
+                            scoresInfo: {
+                                overallMatchScore: 0.95
+                            }
+                        }
+                    ]
+                }
+            }
+        };
+        fetchMock.mockResolvedValueOnce({
+            ok: true,
+            status: 200,
+            json: async () => restResponse
+        });
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'BUSINESS_SOLUTIONS',
+            toolParams: {
+                searchTerm: 'create collection'
+            }
+        });
+        expect(fetchMock).toHaveBeenCalledTimes(1);
+        const [url] = fetchMock.mock.calls[0];
+        expect(url).not.toContain('kbName=REST_METHODS_KB_ID');
+        expect(url).toContain('kbName=REST_DOCS_KB_ID');
+        expect(url).toContain('kbName=MCP_REST_RECIPES_KB_ID');
+        expect(result).toBe('REST Documentation content');
+    });
     test('performs WDS semantic search successfully', async () => {
         const wdsResponse = {
             results: {
@@ -188,7 +252,12 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => wdsResponse
         });
-        const result = await runSemanticSearchAndFormat('WDS', { searchTerm: 'Button component' }, 1);
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'WDS',
+            toolParams: {
+                searchTerm: 'Button component'
+            }
+        });
         expect(fetchMock).toHaveBeenCalledTimes(1);
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('kbName=WDS_DOCS_KB_ID');
@@ -216,7 +285,12 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => buildAppsResponse
         });
-        const result = await runSemanticSearchAndFormat('BUILD_APPS', { searchTerm: 'deploy app' }, 5);
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'BUILD_APPS',
+            toolParams: {
+                searchTerm: 'deploy app'
+            }
+        });
         expect(fetchMock).toHaveBeenCalledTimes(1);
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('kbName=BUILD_APPS_KB_ID');
@@ -244,8 +318,11 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => wixHeadlessResponse
         });
-        const result = await runSemanticSearchAndFormat('WIX_HEADLESS', {
-            searchTerm: 'query'
+        const result = await runSemanticSearchAndFormat({
+            toolName: 'WIX_HEADLESS',
+            toolParams: {
+                searchTerm: 'query'
+            }
         });
         expect(fetchMock).toHaveBeenCalledTimes(1);
         const [url] = fetchMock.mock.calls[0];
@@ -258,7 +335,12 @@ describe('Semantic Search', () => {
             status: 500,
             statusText: 'Internal Server Error'
         });
-        await expect(runSemanticSearchAndFormat('SDK', { searchTerm: 'query' })).rejects.toThrow('Failed to run rag search: Internal Server Error');
+        await expect(runSemanticSearchAndFormat({
+            toolName: 'SDK',
+            toolParams: {
+                searchTerm: 'query'
+            }
+        })).rejects.toThrow('Failed to run rag search: Internal Server Error');
     });
     test('handles empty results', async () => {
         fetchMock.mockResolvedValueOnce({
@@ -266,24 +348,112 @@ describe('Semantic Search', () => {
             status: 200,
             json: async () => ({ results: {} })
         });
-        await expect(runSemanticSearchAndFormat('SDK', { searchTerm: 'query' })).rejects.toThrow('No result from search');
+        await expect(runSemanticSearchAndFormat({
+            toolName: 'SDK',
+            toolParams: {
+                searchTerm: 'query'
+            }
+        })).rejects.toThrow('No result from search');
     });
     test('respects maxResults parameter', async () => {
         const maxResults = 5;
-        await runSemanticSearchAndFormat('SDK', { searchTerm: 'query' }, maxResults);
+        await runSemanticSearchAndFormat({
+            toolName: 'SDK',
+            toolParams: {
+                searchTerm: 'query'
+            },
+            maxResults
+        });
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('maxResults=5');
     });
     test('respects rerank parameter', async () => {
-        await runSemanticSearchAndFormat('SDK', { searchTerm: 'query' }, 5, true);
+        await runSemanticSearchAndFormat({
+            toolName: 'SDK',
+            toolParams: {
+                searchTerm: 'query'
+            },
+            maxResults: 5,
+            rerank: true
+        });
         const [url] = fetchMock.mock.calls[0];
         expect(url).toContain('rerank=true');
     });
-    test('uses WIX_COOKIE when available', async () => {
-        process.env.WIX_COOKIE = 'test-cookie';
-        await runSemanticSearchAndFormat('SDK', { searchTerm: 'query' });
-        expect(fetchMock).toHaveBeenCalledTimes(1);
-        const [, options] = fetchMock.mock.calls[0];
-        expect(options.headers.Cookie).toBe('test-cookie');
+    describe('light mode and long content', () => {
+        test('respects no linesInEachResult parameter - default behavior', async () => {
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 5,
+                rerank: false
+            });
+            expect(result).toContain('line 3');
+        });
+        test('respects linesInEachResult parameter', async () => {
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 5,
+                rerank: false,
+                linesInEachResult: 2
+            });
+            expect(result).toContain('line 2');
+        });
+        test('respects linesInEachResult parameter', async () => {
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 5,
+                rerank: false,
+                linesInEachResult: 1
+            });
+            expect(result).not.toContain('line 2');
+        });
+        test('respects linesInEachResult even if content is too long', async () => {
+            const longContentLines = LONG_KB_CONTENT.split('\n');
+            const longContentLine1 = longContentLines[0];
+            const longContentLine16 = longContentLines[16];
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 10,
+                rerank: false,
+                linesInEachResult: 15
+            });
+            expect(result).toContain(longContentLine1);
+            expect(result).not.toContain('some-chunked-content');
+            expect(result).not.toContain(longContentLine16);
+        });
+        test('uses chunked content if content is too long and linesInEachResult is not set', async () => {
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 10,
+                rerank: false
+            });
+            expect(result).toContain('some-chunked-content');
+        });
+        test('uses chunked content if content is too long and linesInEachResult is set', async () => {
+            const result = await runSemanticSearchAndFormat({
+                toolName: 'SDK',
+                toolParams: {
+                    searchTerm: 'query'
+                },
+                maxResults: 10,
+                rerank: false,
+                linesInEachResult: 1500
+            });
+            expect(result).toContain('some-chunked-content');
+        });
     });
 });

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export { WixMcpServer } from './wix-mcp-server.js';
+export { addDocsTools, DocsTool, VALID_DOCS_TOOLS } from './docs/docs.js';
+export { addApiCallTool } from './api-call/index.js';
+export { handleWixAPIResponse } from './tool-utils.js';
+export { addDocsResources } from './resources/docs.js';

package/build/index.js

@@ -1,109 +1,5 @@
-import './sentry.js';
-import minimist from 'minimist';
-import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import { addDocsTools, VALID_DOCS_TOOLS } from './docs/docs.js';
-import { addCliTools, VALID_CLI_TOOLS } from './cli-tools/cli.js';
-import { logger, attachStdErrLogger, attachMcpServerLogger, attachFileLogger } from './logger.js';
-import { WixMcpServer } from './wix-mcp-server.js';
-import { addDocsResources } from './resources/docs.js';
-const VALID_TOOLS = [
-    'WDS',
-    'REST',
-    'SDK',
-    'BUILD_APPS',
-    'WIX_HEADLESS'
-];
-const EXPERIMENTAL_TOOLS = ['WIX_API', 'CLI_COMMAND'];
-export const DEFAULT_TOOLS = [
-    'WDS',
-    'REST',
-    'SDK',
-    'BUILD_APPS',
-    'WIX_HEADLESS'
-];
-const parsedArgs = minimist(process.argv.slice(2));
-function parseExperimentalArg() {
-    const experimentalArg = parsedArgs['experimental'];
-    if (!experimentalArg)
-        return [];
-    return experimentalArg
-        .split(',')
-        .map((t) => t.trim())
-        .filter((tool) => EXPERIMENTAL_TOOLS.includes(tool));
-}
-function parseToolsArg() {
-    const toolsArg = parsedArgs['tools'];
-    const experimentalTools = parseExperimentalArg();
-    if (!toolsArg) {
-        // When no tools specified, return both default and experimental tools
-        return [...DEFAULT_TOOLS, ...experimentalTools];
-    }
-    const requestedTools = toolsArg.split(',').map((t) => t.trim());
-    const tools = [
-        // Include valid non-experimental tools
-        ...requestedTools.filter((tool) => VALID_TOOLS.includes(tool)),
-        // Include enabled experimental tools
-        ...experimentalTools
-    ];
-    // Warn about enabled experimental tools
-    tools.forEach((tool) => {
-        if (EXPERIMENTAL_TOOLS.includes(tool)) {
-            logger.log(`Warning: ${tool} is an experimental tool and may have limited functionality or breaking changes`);
-        }
-    });
-    return tools;
-}
-const loggerType = parsedArgs['logger'] || 'mcp';
-if (loggerType === 'file') {
-    attachFileLogger();
-}
-else {
-    // Initially we log to stderr, because MCP server is not connected yet
-    // When the server is connected, we attach the MCP server logger
-    attachStdErrLogger();
-}
-logger.log('--------------------------------');
-logger.log('starting WIX MCP server');
-logger.log('--------------------------------');
-const server = new WixMcpServer({
-    name: 'wix-mcp-server',
-    version: '1.0.0'
-}, {
-    capabilities: {
-        tools: {},
-        prompts: {},
-        logging: {},
-        resources: {}
-    }
-});
-const activeTools = parseToolsArg();
-logger.log('Active tools:', activeTools);
-const docsTools = activeTools.filter((tool) => VALID_DOCS_TOOLS.includes(tool));
-if (docsTools.length > 0) {
-    logger.log('Adding docs tools:', docsTools);
-    addDocsTools(server, docsTools);
-}
-const cliTools = activeTools.filter((tool) => VALID_CLI_TOOLS.includes(tool));
-if (cliTools.length > 0) {
-    logger.log('Adding cli tools:', cliTools);
-    addCliTools(server, cliTools);
-}
-try {
-    const portals = parsedArgs['portals']?.split(',') || [];
-    if (portals.length > 0) {
-        logger.log('Adding docs resources for portals:', portals);
-        await addDocsResources(server, portals);
-    }
-}
-catch (error) {
-    logger.error('Error adding docs resources:', error);
-}
-logger.log('Starting server');
-const transport = new StdioServerTransport();
-logger.log('Connecting to transport');
-await server.connect(transport);
-logger.log('Transport connected');
-if (loggerType === 'mcp') {
-    // From now on, we log to the MCP server
-    attachMcpServerLogger(server);
-}
+export { WixMcpServer } from './wix-mcp-server.js';
+export { addDocsTools, VALID_DOCS_TOOLS } from './docs/docs.js';
+export { addApiCallTool } from './api-call/index.js';
+export { handleWixAPIResponse } from './tool-utils.js';
+export { addDocsResources } from './resources/docs.js';

package/build/interactive-command-tools/eventually.d.ts

@@ -0,0 +1,6 @@
+interface Options {
+    timeout?: number;
+    interval?: number;
+}
+export default function eventually<ReturnType = void>(expectation: () => ReturnType | Promise<ReturnType>, options?: Options): Promise<ReturnType>;
+export {};

package/build/interactive-command-tools/handleStdout.d.ts

@@ -0,0 +1,13 @@
+import Stream from 'node:stream';
+export declare function handleStdout(stdout: Stream.Readable): {
+    waitForText(match: string | RegExp, { timeout }?: {
+        timeout?: number | undefined;
+    }): Promise<string | undefined>;
+    waitForAndCallback(matchesAndCallbacks: {
+        match: string;
+        callback: (stop: () => void) => void;
+    }[], { timeout }?: {
+        timeout?: number | undefined;
+    }): Promise<unknown>;
+    getOutput(): Promise<string>;
+};

package/build/interactive-command-tools/interactive-command-utils.d.ts

@@ -0,0 +1,7 @@
+import Stream from 'node:stream';
+export declare const ENTER = "\r";
+export declare const mockInteractiveGenerateCommandTool: ({ extensionType, stdin, stdout }: {
+    extensionType: string;
+    stdin: Stream.Writable;
+    stdout: Stream.Readable;
+}) => Promise<string>;

package/build/logger.d.ts

@@ -0,0 +1,10 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+interface Logger {
+    log(...data: unknown[]): void;
+    error(...data: unknown[]): void;
+}
+export declare const logger: Logger;
+export declare const attachMcpServerLogger: (server: McpServer) => void;
+export declare const attachStdErrLogger: () => void;
+export declare const attachFileLogger: () => void;
+export {};

package/build/panorama.d.ts

@@ -0,0 +1,2 @@
+export declare const globalConfig: import("@wix/panorama-client-node").GlobalConfig<import("@wix/panorama-common-shared/dist/types/types/data-types.js").EventPayload, {}>;
+export declare const panoramaFactory: import("@wix/panorama-client").PanoramaClientFactory<import("@wix/panorama-common-shared/dist/types/types/data-types.js").EventPayload>;

package/build/panorama.js

@@ -1,7 +1,12 @@
-import { createRequire } from 'module';
+// import { createRequire } from 'module';
 import { createGlobalConfig, panoramaClientFactory, PanoramaPlatform } from '@wix/panorama-client-node';
-const require = createRequire(import.meta.url);
-const packageJson = require('../package.json');
+// const require = createRequire(import.meta.url);
+// const packageJson = require('../package.json');
+// TODO: use real package.json
+// I temporarily disabled this because it's not working in the remote server
+const packageJson = {
+    version: '1.0.0'
+};
 export const globalConfig = createGlobalConfig();
 export const panoramaFactory = panoramaClientFactory({
     baseParams: {

package/build/resources/docs.d.ts

@@ -0,0 +1,2 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare const addDocsResources: (server: McpServer, portals: string[]) => Promise<void>;

package/build/sentry.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tool-utils.d.ts

@@ -0,0 +1 @@
+export declare const handleWixAPIResponse: <T = any>(response: Response) => Promise<T>;