@greensecurity/javascript-sdk 0.9.1 → 0.11.0

package/README.md

@@ -34,17 +34,6 @@ Some useful links:
 <!-- $toc-max-depth=2 -->
 * [greensecurity](#greensecurity)
   * [SDK Installation](#sdk-installation)
-  * [Requirements](#requirements)
-  * [SDK Example Usage](#sdk-example-usage)
-  * [Authentication](#authentication)
-  * [Available Resources and Operations](#available-resources-and-operations)
-  * [Standalone functions](#standalone-functions)
-  * [React hooks with TanStack Query](#react-hooks-with-tanstack-query)
-  * [Retries](#retries)
-  * [Error Handling](#error-handling)
-  * [Server Selection](#server-selection)
-  * [Custom HTTP Client](#custom-http-client)
-  * [Debugging](#debugging)
 * [Development](#development)
   * [Maturity](#maturity)
   * [Contributions](#contributions)
@@ -90,6 +79,73 @@ yarn add @tanstack/react-query react react-dom
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+
+
+### 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.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "GreenSecurity": {
+      "command": "npx",
+      "args": ["-y", "--package", "@greensecurity/javascript-sdk", "--", "mcp", "start"],
+      "env": {
+        "GREEN_SECURITY_TOKEN": "...",
+        "GREEN_SECURITY_BEARER_JWT": "..."
+      }
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+1. Create a shell script called `mcp-green_security.sh` with the following content:
+
+    ```sh
+    #!/bin/sh
+     
+    export GREEN_SECURITY_TOKEN="..." 
+    export GREEN_SECURITY_BEARER_JWT="..."
+
+    exec npx -y --package @greensecurity/javascript-sdk -- mcp start "$@"
+    ```
+
+2. Then make it executable with the following command:
+
+    ```sh
+    chmod +x mcp-green_security.sh
+    ```
+
+3. In Cursor, `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
+
+    | Field   | Value |
+    | ------- | ----- |
+    | Name    | GreenSecurity |
+    | Type    | `command` |
+    | Command | `/path/to/mcp-green_security.sh` |
+
+</details>
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @greensecurity/javascript-sdk -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -185,6 +241,9 @@ run();
 * [getCurrentUser](docs/sdks/user/README.md#getcurrentuser) - Get current user
 * [getUserById](docs/sdks/user/README.md#getuserbyid) - Get user by id
 * [logsUserIntoTheSystem](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
+* [magiclink](docs/sdks/user/README.md#magiclink) - Magic link
+* [passwordResetRequest](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
+* [password](docs/sdks/user/README.md#password) - Password reset
 
 ### [vendors](docs/sdks/vendors/README.md)
 
@@ -214,6 +273,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`userGetCurrentUser`](docs/sdks/user/README.md#getcurrentuser) - Get current user
 - [`userGetUserById`](docs/sdks/user/README.md#getuserbyid) - Get user by id
 - [`userLogsUserIntoTheSystem`](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
+- [`userMagiclink`](docs/sdks/user/README.md#magiclink) - Magic link
+- [`userPassword`](docs/sdks/user/README.md#password) - Password reset
+- [`userPasswordResetRequest`](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
 - [`vendorsCreateVendorRegistration`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`vendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
 
@@ -247,6 +309,9 @@ To learn about this feature and how to get started, check
 - [`useUserGetCurrentUser`](docs/sdks/user/README.md#getcurrentuser) - Get current user
 - [`useUserGetUserById`](docs/sdks/user/README.md#getuserbyid) - Get user by id
 - [`useUserLogsUserIntoTheSystemMutation`](docs/sdks/user/README.md#logsuserintothesystem) - Logs user into the system
+- [`useUserMagiclinkMutation`](docs/sdks/user/README.md#magiclink) - Magic link
+- [`useUserPasswordMutation`](docs/sdks/user/README.md#password) - Password reset
+- [`useUserPasswordResetRequestMutation`](docs/sdks/user/README.md#passwordresetrequest) - Password reset request
 - [`useVendorsCreateVendorRegistrationMutation`](docs/sdks/vendors/README.md#createvendorregistration) - Create vendor registration
 - [`useVendorsListVendorJobTitles`](docs/sdks/vendors/README.md#listvendorjobtitles) - List vendor job titles
 
@@ -411,11 +476,11 @@ 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 index to the `serverIdx: number` 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 indexes associated with the available servers:
 
-| #   | Server                                     |
-| --- | ------------------------------------------ |
-| 0   | `https://www.greensecurityllc.com/api`     |
-| 1   | `https://staging.greensecurityllc.com/api` |
-| 2   | `https://localhost:3000/api`               |
+| #   | Server                                     | Description        |
+| --- | ------------------------------------------ | ------------------ |
+| 0   | `https://www.greensecurityllc.com/api`     | Production API URL |
+| 1   | `https://staging.greensecurityllc.com/api` | Staging API URL    |
+| 2   | `https://localhost:3000/api`               | Localhost API URL  |
 
 #### Example