ce-storefront 0.7.2 → 0.8.1

package/README.md

@@ -64,6 +64,89 @@ yarn add ce-storefront zod
 > [!NOTE]
 > This package is published as an ES Module (ESM) only. For applications using
 > CommonJS, use `await import("ce-storefront")` to import and use this package.
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> Node.js v20 or greater is required to run the MCP server from npm.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "CeStorefront": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "ce-storefront",
+        "--",
+        "mcp", "start",
+        "--authorization", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Create a `.cursor/mcp.json` file in your project root with the following content:
+
+```json
+{
+  "mcpServers": {
+    "CeStorefront": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "ce-storefront",
+        "--",
+        "mcp", "start",
+        "--authorization", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
+
+```bash
+curl -L -o mcp-server \
+    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
+chmod +x mcp-server
+```
+
+If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
+
+
+```json
+{
+  "mcpServers": {
+    "Todos": {
+      "command": "./DOWNLOAD/PATH/mcp-server",
+      "args": [
+        "start"
+      ]
+    }
+  }
+}
+```
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package ce-storefront -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -146,7 +229,6 @@ run();
 * [getVariantDetail](docs/sdks/catalog/README.md#getvariantdetail) - Retrieve variant detail
 * [listCategories](docs/sdks/catalog/README.md#listcategories) - List all categories
 * [listProductReviews](docs/sdks/catalog/README.md#listproductreviews) - List all product reviews
-* [createProductReview](docs/sdks/catalog/README.md#createproductreview) - Create product review
 * [listSimilarProducts](docs/sdks/catalog/README.md#listsimilarproducts) - Retrieve similar products
 * [listUpsellProducts](docs/sdks/catalog/README.md#listupsellproducts) - Retrieve up-sell products
 * [listCrosssellProducts](docs/sdks/catalog/README.md#listcrosssellproducts) - Retrieve cross-sell products
@@ -222,7 +304,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`cartsRemoveCoupon`](docs/sdks/carts/README.md#removecoupon) - Remove coupon
 - [`cartsRemoveUserCart`](docs/sdks/carts/README.md#removeusercart) - Delete cart using user id
 - [`cartsUpdateCart`](docs/sdks/carts/README.md#updatecart) - Add/delete cart item
-- [`catalogCreateProductReview`](docs/sdks/catalog/README.md#createproductreview) - Create product review
 - [`catalogGetProductDetail`](docs/sdks/catalog/README.md#getproductdetail) - Retrieve a product detail
 - [`catalogGetVariantDetail`](docs/sdks/catalog/README.md#getvariantdetail) - Retrieve variant detail
 - [`catalogListCategories`](docs/sdks/catalog/README.md#listcategories) - List all categories
@@ -408,12 +489,16 @@ In some rare cases, the SDK can fail to get a response from the server or even m
 
 You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
 
-| Name      | Server                                                              | Variables         | Default values |
-| --------- | ------------------------------------------------------------------- | ----------------- | -------------- |
-| `staging` | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `storeId: string` | `"store_id"`   |
-| `prod`    | `https://prod.api.commercengine.io/api/v1/{store_id}/storefront`    | `storeId: string` | `"store_id"`   |
+| Name      | Server                                                              | Variables  | Description    |
+| --------- | ------------------------------------------------------------------- | ---------- | -------------- |
+| `staging` | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` | Staging Server |
+| `prod`    | `https://prod.api.commercengine.io/api/v1/{store_id}/storefront`    | `store_id` | Prod Server    |
+
+If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:
 
-If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
+| Variable   | Parameter         | Default      | Description |
+| ---------- | ----------------- | ------------ | ----------- |
+| `store_id` | `storeId: string` | `"store_id"` | Store ID    |
 
 #### Example
 
@@ -422,6 +507,7 @@ import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
   server: "prod",
+  storeId: "<id>",
   authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });