@greensecurity/javascript-sdk 0.10.2 → 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] -->