@launchdarkly/mcp-server 0.4.2 → 0.6.0

package/README.md

@@ -93,6 +93,34 @@ Specify your API key as found on LaunchDarkly's Authorization page.
 
 5. Click `Save`.
 
+### GitHub Copilot CLI installation steps
+
+Use the Copilot CLI to interactively add the MCP server:
+
+```bash
+/mcp add
+```
+
+Or create/edit `~/.copilot/mcp-config.json` with the following content:
+
+```json
+{
+  "mcpServers": {
+    "LaunchDarkly": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@launchdarkly/mcp-server", "--", "mcp", "start",
+        "--api-key", "api-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+      ]
+    }
+  }
+}
+```
+
+Specify your API key as found on LaunchDarkly's Authorization page.
+
+For more information, see the [GitHub Copilot CLI documentation](https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli).
+
 ### Standalone binary installation steps
 
 You can also run the MCP server as a standalone binary with no additional dependencies. You must pull these binaries from available GitHub releases while specifying the appropriate `tag` value:
@@ -122,6 +150,59 @@ Then, configure your server definition to reference your local clone. For exampl
 }
 ```
 
+### Installation steps using environment variables
+
+Some AI clients allow for accessing environment variables within MCP configurations. In AI clients where this is supported, you can configure your MCP server to read from an environment variable like `MCP_LD_TOKEN` as follows:
+
+```json
+{
+  "mcpServers": {
+    "launchdarkly": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@launchdarkly/mcp-server", "--", "mcp", "start",
+        "--api-key", "$LD_ACCESS_TOKEN"
+      ],
+      "env": {
+        "LD_ACCESS_TOKEN": "MCP_LD_TOKEN"
+      }
+    }
+  }
+}
+```
+
+### Installation steps for Docker
+
+If installing the MCP server from the AWS Markeplace, pull the image using an authenticated role using the provided instructions in the marketplace listing.
+
+To run the container:
+
+```bash
+docker run --rm -p 8080:8080 709825985650.dkr.ecr.us-east-1.amazonaws.com/launchdarkly/mcp --api-key api-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 
+```
+
+Then, configure your server definition to reference your local clone. For example:
+
+```json
+{
+  "mcpServers": {
+    "launchdarkly": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@launchdarkly/mcp-server", "--", "mcp", "start",
+        "--api-key", "$LD_ACCESS_TOKEN"
+      ],
+      "env": {
+        "LD_ACCESS_TOKEN": "MCP_LD_TOKEN"
+      }
+      "url": "http://localhost:8080/sse"
+    }
+  }
+}
+```
+
+This won't work in AI clients (such as Cursor) which don't support accessing environment variables directly within MCP configurations. As a workaround, you can invoke a local script from your MCP configuration. See [here](https://github.com/launchdarkly/mcp-server/issues/26#issuecomment-3064419507) for an example.
+
 <!-- Start Requirements [requirements] -->
 ## Requirements
 
@@ -138,7 +219,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <details open>
 <summary>Available methods</summary>
 
-### [aiConfigs](docs/sdks/aiconfigs/README.md)
+### [AiConfigs](docs/sdks/aiconfigs/README.md)
 
 * [getTargeting](docs/sdks/aiconfigs/README.md#gettargeting) - Show an AI Config's targeting
 * [updateTargeting](docs/sdks/aiconfigs/README.md#updatetargeting) - Update AI Config targeting
@@ -152,15 +233,15 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 * [getVariation](docs/sdks/aiconfigs/README.md#getvariation) - Get AI Config variation
 * [updateVariation](docs/sdks/aiconfigs/README.md#updatevariation) - Update AI Config variation
 
-### [codeReferences](docs/sdks/codereferences/README.md)
+### [CodeReferences](docs/sdks/codereferences/README.md)
 
 * [listRepositories](docs/sdks/codereferences/README.md#listrepositories) - List repositories
 
-### [environments](docs/sdks/environments/README.md)
+### [Environments](docs/sdks/environments/README.md)
 
 * [listByProject](docs/sdks/environments/README.md#listbyproject) - List environments
 
-### [featureFlags](docs/sdks/featureflags/README.md)
+### [FeatureFlags](docs/sdks/featureflags/README.md)
 
 * [getStatus](docs/sdks/featureflags/README.md#getstatus) - Get flag status across environments
 * [list](docs/sdks/featureflags/README.md#list) - List feature flags
@@ -169,7 +250,6 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 * [patch](docs/sdks/featureflags/README.md#patch) - Update feature flag
 * [delete](docs/sdks/featureflags/README.md#delete) - Delete feature flag
 
-
 </details>
 <!-- End Available Resources and Operations [operations] -->
 

package/RUNTIMES.md

@@ -2,9 +2,9 @@
 
 This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
 
-* [Web Fetch API][web-fetch]
-* [Web Streams API][web-streams] and in particular `ReadableStream`
-* [Async iterables][async-iter] using `Symbol.asyncIterator`
+- [Web Fetch API][web-fetch]
+- [Web Streams API][web-streams] and in particular `ReadableStream`
+- [Async iterables][async-iter] using `Symbol.asyncIterator`
 
 [web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
 [web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
@@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:
 
 The following `tsconfig.json` options are recommended for projects using this
 SDK in order to get static type support for features like async iterables,
-streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+streams and `fetch`-related APIs ([`for await...of`][for-await-of],
 [`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
 so on):
 
@@ -38,11 +38,11 @@ so on):
 {
   "compilerOptions": {
     "target": "es2020", // or higher
-    "lib": ["es2020", "dom", "dom.iterable"],
+    "lib": ["es2020", "dom", "dom.iterable"]
   }
 }
 ```
 
 While `target` can be set to older ECMAScript versions, it may result in extra,
 unnecessary compatibility code being generated if you are not targeting old
-runtimes.
+runtimes.