Skip to content

Commit b50b3da

Browse files
authored
More changes to repo documentation, adding a license (#5)
1 parent 9e16649 commit b50b3da

File tree

3 files changed

+50
-16
lines changed

3 files changed

+50
-16
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 LaunchDarkly
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
The official [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server for [LaunchDarkly](https://launchdarkly.com/).
44

55
<div align="left">
6-
<a href="https://www.speakeasy.com/?utm_source=@launchdarkly/mcp-server&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
76
<a href="https://opensource.org/licenses/MIT">
87
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
98
</a>
@@ -138,25 +137,31 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
138137

139138
## Available environments
140139

141-
Most customer accounts run on LaunchDarkly's commercial (default) environment. Customers on other environments can specify the `--server-url` argument to connect to the appropriate environment. For example, customers on LaunchDarkly's Federal environment should specify `--server-url https://app.launchdarkly.us` when starting their MCP server.
140+
Most customer accounts run on LaunchDarkly's commercial (default) environment. Customers on other environments can specify the `--server-url` argument to connect to the appropriate environment. For example, customers on LaunchDarkly's Federal environment should specify the `--server-url https://app.launchdarkly.us` argument when starting their MCP server.
142141

143-
| # | Server URL | Environment |
144-
| --- | --------------------------------- | -------------------- |
145-
| 0 | `https://app.launchdarkly.com` | Commercial (Default) |
146-
| 1 | `https://app.launchdarkly.us` | Federal |
147-
| 2 | `https://app.eu.launchdarkly.com` | EU |
148-
149-
# Development
150-
151-
## Maturity
152-
153-
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
154-
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
155-
looking for the latest version.
142+
| Environment | Server URL |
143+
| -------------------- | --------------------------------- |
144+
| Commercial (Default) | `https://app.launchdarkly.com` |
145+
| Federal | `https://app.launchdarkly.us` |
146+
| EU | `https://app.eu.launchdarkly.com` |
156147

157148
## Contributions
158149

159150
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
160151
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
161152

162-
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@launchdarkly/mcp-server&utm_campaign=typescript)
153+
## About LaunchDarkly
154+
155+
- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
156+
- Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
157+
- Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
158+
- Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
159+
- Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan).
160+
- Disable parts of your application to facilitate maintenance, without taking everything offline.
161+
- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://launchdarkly.com/docs/sdk) for a complete list.
162+
- Explore LaunchDarkly
163+
- [https://app.launchdarkly.com/signup](Sign up for a free LaunchDarkly account here)
164+
- [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
165+
- [launchdarkly.com/docs](https://launchdarkly.com/docs/home 'LaunchDarkly Documentation') for our documentation and SDK reference guides
166+
- [launchdarkly.com/docs/api](https://launchdarkly.com/docs/api 'LaunchDarkly API Documentation') for our API documentation
167+
- [blog.launchdarkly.com](https://launchdarkly.com/blog/ 'LaunchDarkly Blog Documentation') for the latest product updates

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
"type": "git",
2727
"url": "https://github.com/launchdarkly/mcp-server.git"
2828
},
29+
"keywords": [
30+
"feature-flags",
31+
"feature-toggles",
32+
"launchdarkly",
33+
"mcp",
34+
"modelcontextprotocol"
35+
],
36+
"license": "MIT",
2937
"scripts": {
3038
"lint": "eslint --cache --max-warnings=0 src",
3139
"build:mcp": "bun src/mcp-server/build.mts",

0 commit comments

Comments
 (0)