@configcat/mcp-server 0.1.4 → 0.1.5

package/DEPLOY.md

@@ -1,7 +1,9 @@
 # Steps to deploy
 ## Preparation
 1. Increase the `serverVersion` in [src/index.ts](src/index.ts).
-2. Commit & Push
+2. Increase the `version` in [server.json](server.json).
+3. Increase the `version` in [package.json](package.json).
+4. Commit & Push
 ## Publish
 Use the **same version** for the git tag as in [src/index.ts](src/index.ts).
 - Via git tag

package/build/index.js

@@ -8,7 +8,7 @@ const baseUrl = process.env.CONFIGCAT_BASE_URL ?? "https://api.configcat.com";
 const username = process.env.CONFIGCAT_API_USER ?? "";
 const password = process.env.CONFIGCAT_API_PASS ?? "";
 const serverName = "ConfigCat MCP";
-const serverVersion = "0.1.4";
+const serverVersion = "0.1.5";
 const http = new HttpClient({ baseUrl, username, password, userAgent: `${serverName}/${serverVersion}` });
 const server = new McpServer({ name: serverName, version: serverVersion }, { capabilities: { tools: {} } });
 async function main() {

package/build/tools/configcat-api.js

@@ -185,6 +185,7 @@ The Parameters dictionary differs for each IntegrationType:
 - Slack  
   Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook.
   - \`incoming_webhook.url\`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages.
+  - \`includeSensitiveData\`: Set to "true" to include [sensitive (hashed) comparison values](https://configcat.com/docs/targeting/targeting-rule/user-condition/#confidential-text-comparators). By default, the integration will mask these values in the posted messages. We recommend hiding sensitive comparison values for shared or public Slack channels.
 - Amplitude
   - \`apiKey\`: Required. Amplitude API Key.
   - \`secretKey\`: Required. Amplitude Secret Key.
@@ -201,10 +202,10 @@ The Parameters dictionary differs for each IntegrationType:
                 productId: z.string().uuid().describe("The identifier of the Product."),
                 requestBody: z.object({
                     integrationType: z.enum(["dataDog", "slack", "amplitude", "mixPanel", "segment", "pubNub"]),
-                    name: z.string().min(1).describe("Name of the Integration."),
+                    name: z.string().min(1).max(255).describe("Name of the Integration."),
                     parameters: z.record(z.string().nullable()).describe("Parameters of the Integration."),
-                    environmentIds: z.array(z.string().uuid()).describe("List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected."),
-                    configIds: z.array(z.string().uuid()).describe("List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected."),
+                    environmentIds: z.array(z.string().uuid()).describe("List of Environment IDs that are connected with this Integration. If the list is empty, all the Environments are connected."),
+                    configIds: z.array(z.string().uuid()).describe("List of Config IDs that are connected with this Integration. If the list is empty, all the Configs are connected."),
                 }),
             },
             method: "post",
@@ -272,9 +273,19 @@ identified by the \`configId\` parameter.
                     key: z.string().min(1).max(255).describe("The key of the Feature Flag or Setting."),
                     name: z.string().min(1).max(255).describe("The name of the Feature Flag or Setting."),
                     settingType: z.enum(["boolean", "string", "int", "double"]).describe("The type of the Feature Flag or Setting."),
+                    predefinedVariations: z.array(z.object({
+                        value: z.object({
+                            boolValue: z.boolean().nullable().optional().describe("The served value in case of a boolean Feature Flag."),
+                            stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
+                            intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
+                            doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                        }).describe("Represents the value of a Predefined Variation."),
+                        name: z.string().min(0).max(255).nullable().optional().describe("The name of the Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown."),
+                        hint: z.string().min(0).max(1000).nullable().optional().describe("The name of the Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown."),
+                    }).describe("A Predefined Variation.")).nullable().optional().describe("The Feature Flag or Setting's Variations."),
                     initialValues: z.array(z.object({
                         environmentId: z.string().uuid().describe("The ID of the Environment where the initial value must be set."),
-                        value: z.union([z.boolean(), z.string(), z.number()]).describe("The initial value in the given Environment. It must respect the setting type. In some generated clients for strictly typed languages you may use double/float properties to handle integer values."),
+                        value: z.union([z.boolean(), z.string(), z.number()]).describe("The initial value in the given Environment. It must respect the setting type. In some generated clients for strictly typed languages, you may use double/float properties to handle integer values. In case of a Feature Flag with predefined variations, the value must match one of the predefined variations' value."),
                     })).nullable().optional().describe("Optional, initial value of the Feature Flag or Setting in the given Environments. Only one of the SettingIdToInitFrom or the InitialValues properties can be set."),
                     settingIdToInitFrom: z.number().int().nullable().optional().describe("Optional, the SettingId to initialize the values and tags of the Feature Flag or Setting from. Only can be set if you have at least ReadOnly access in all the Environments. Only one of the SettingIdToInitFrom or the InitialValues properties can be set."),
                 }),
@@ -301,7 +312,8 @@ The distance between \`fromUtcDateTime\` and \`toUtcDateTime\` cannot exceed **3
                     "teamMemberRemoved", "teamMemberLeft", "teamMemberInvitationChanged", "teamMemberInvitationResent",
                     "teamMemberInvitationRejected", "configCreated", "configChanged", "configDeleted", "configsReordered",
                     "environmentCreated", "environmentChanged", "environmentDeleted", "environmentsReordered", "settingCreated",
-                    "settingChanged", "settingDeleted", "settingsReordered", "settingValueChanged", "webHookCreated",
+                    "settingChanged", "settingDeleted", "settingsReordered", "predefinedVariationsChanged",
+                    "settingConvertedToPredefinedVariations", "settingConvertedToFreeFormValues", "settingValueChanged", "webHookCreated",
                     "webHookChanged", "webHookDeleted", "permissionGroupCreated", "permissionGroupChanged", "permissionGroupDeleted",
                     "permissionGroupDefault", "apiKeyAdded", "apiKeyRemoved", "integrationAdded", "integrationChanged",
                     "integrationRemoved", "apiKeyConnected", "integrationLinkAdded", "integrationLinkRemoved", "organizationAdded",
@@ -513,6 +525,7 @@ The Parameters dictionary differs for each IntegrationType:
 - Slack  
   Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook.
   - \`incoming_webhook.url\`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages.
+  - \`includeSensitiveData\`: Set to "true" to include [sensitive (hashed) comparison values](https://configcat.com/docs/targeting/targeting-rule/user-condition/#confidential-text-comparators). By default, the integration will mask these values in the posted messages. We recommend hiding sensitive comparison values for shared or public Slack channels.
 - Amplitude
   - \`apiKey\`: Required. Amplitude API Key.
   - \`secretKey\`: Required. Amplitude Secret Key.
@@ -528,10 +541,10 @@ The Parameters dictionary differs for each IntegrationType:
             inputSchema: {
                 integrationId: z.string().uuid().describe("The identifier of the Integration."),
                 requestBody: z.object({
-                    name: z.string().min(1).describe("Name of the Integration."),
+                    name: z.string().min(1).max(255).describe("Name of the Integration."),
                     parameters: z.record(z.string().nullable()).describe("Parameters of the Integration."),
-                    environmentIds: z.array(z.string().uuid()).describe("List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected."),
-                    configIds: z.array(z.string().uuid()).describe("List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected."),
+                    environmentIds: z.array(z.string().uuid()).describe("List of Environment IDs that are connected with this Integration. If the list is empty, all the Environments are connected."),
+                    configIds: z.array(z.string().uuid()).describe("List of Config IDs that are connected with this Integration. If the list is empty, all the Configs are connected."),
                 }),
             },
             method: "put",
@@ -578,7 +591,8 @@ The distance between \`fromUtcDateTime\` and \`toUtcDateTime\` cannot exceed **3
                     "teamMemberRemoved", "teamMemberLeft", "teamMemberInvitationChanged", "teamMemberInvitationResent",
                     "teamMemberInvitationRejected", "configCreated", "configChanged", "configDeleted", "configsReordered",
                     "environmentCreated", "environmentChanged", "environmentDeleted", "environmentsReordered", "settingCreated",
-                    "settingChanged", "settingDeleted", "settingsReordered", "settingValueChanged", "webHookCreated",
+                    "settingChanged", "settingDeleted", "settingsReordered", "predefinedVariationsChanged",
+                    "settingConvertedToPredefinedVariations", "settingConvertedToFreeFormValues", "settingValueChanged", "webHookCreated",
                     "webHookChanged", "webHookDeleted", "permissionGroupCreated", "permissionGroupChanged", "permissionGroupDeleted",
                     "permissionGroupDefault", "apiKeyAdded", "apiKeyRemoved", "integrationAdded", "integrationChanged",
                     "integrationRemoved", "apiKeyConnected", "integrationLinkAdded", "integrationLinkRemoved", "organizationAdded",
@@ -643,6 +657,40 @@ given Product identified by the \`productId\` parameter.`,
             pathTemplate: "/v1/products/{productId}/invitations",
             executionParameters: [{ "name": "productId", "in": "path" }],
         }],
+    ["list-predefined-variations", {
+            name: "list-predefined-variations",
+            description: "This endpoint returns the predefined variations along with their usages in the Environments for a Feature Flag or Setting identified by the `settingId` parameter.",
+            inputSchema: {
+                settingId: z.number().int().describe("The identifier of the Setting."),
+            },
+            method: "get",
+            pathTemplate: "/v1/settings/{settingId}/predefined-variations",
+            executionParameters: [{ "name": "settingId", "in": "path" }],
+        }],
+    ["update-predefined-variations", {
+            name: "update-predefined-variations",
+            description: `This endpoint updates the predefined variations for a Feature Flag or Setting identified by the \`settingId\` parameter.
+**Important:** You can only update a predefined variation's value if it is not used anywhere in your feature flags.`,
+            inputSchema: {
+                settingId: z.number().int().describe("The identifier of the Setting."),
+                requestBody: z.object({
+                    predefinedVariations: z.array(z.object({
+                        value: z.object({
+                            boolValue: z.boolean().nullable().optional().describe("The served value in case of a boolean Feature Flag."),
+                            stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
+                            intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
+                            doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                        }).describe("Represents the value of a Predefined Variation."),
+                        name: z.string().min(0).max(255).nullable().optional().describe("The name of the Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown."),
+                        hint: z.string().min(0).max(1000).nullable().optional().describe("The name of the Predefined Variation, shown on the Dashboard UI. If not set, the Value will be shown."),
+                        predefinedVariationId: z.string().uuid().nullable().optional().describe("The Predefined Variation's identifier to update. Omit the value if you want to add a new predefined variation."),
+                    }).describe("A Predefined Variation.")).describe("A collection of Predefined Variations."),
+                }),
+            },
+            method: "put",
+            pathTemplate: "/v1/settings/{settingId}/predefined-variations",
+            executionParameters: [{ "name": "settingId", "in": "path" }],
+        }],
     ["get-product", {
             name: "get-product",
             description: `This endpoint returns the metadata of a Product 
@@ -786,10 +834,10 @@ want to change in its original state. Not listing one means it will reset.`,
             inputSchema: {
                 settingId: z.number().int().describe("The identifier of the Setting."),
                 requestBody: z.object({
-                    hint: z.string().min(0).max(1000).nullable().describe("A short description for the setting, shown on the Dashboard UI."),
-                    tags: z.array(z.number().int()).nullable().describe("The IDs of the tags which are attached to the setting."),
-                    order: z.number().int().nullable().describe("The order of the Setting represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers."),
-                    name: z.string().min(1).max(255).nullable().describe("The name of the Feature Flag or Setting."),
+                    name: z.string().min(1).max(255).describe("The name of the Feature Flag or Setting."),
+                    hint: z.string().min(0).max(1000).nullable().optional().describe("A short description for the setting, shown on the Dashboard UI."),
+                    tags: z.array(z.number().int()).nullable().optional().describe("The IDs of the tags which are attached to the setting."),
+                    order: z.number().int().nullable().optional().describe("The order of the Setting represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers."),
                 }),
             },
             method: "put",
@@ -1158,6 +1206,7 @@ So we get a response like this:
                         stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                         intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                         doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                        predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                     }).describe("Represents the value of a Feature Flag or Setting."),
                     targetingRules: z.array(z.object({
                         conditions: z.array(z.object({
@@ -1185,6 +1234,7 @@ So we get a response like this:
                                     stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                                     intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                                     doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                                    predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                                 }).describe("Represents the value of a Feature Flag or Setting."),
                             }).nullable().optional().describe("Describes a condition that is based on a prerequisite flag."),
                         })).nullable().optional().describe("The list of conditions that are combined with logical AND operators. It can be one of the following: User condition, Segment condition, Prerequisite flag condition"),
@@ -1195,6 +1245,7 @@ So we get a response like this:
                                 stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                                 intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                                 doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                                predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                             }).describe("Represents the value of a Feature Flag or Setting."),
                         })).nullable().optional().describe("The percentage options from where the evaluation process will choose a value based on the flag's percentage evaluation attribute."),
                         value: z.object({
@@ -1202,6 +1253,7 @@ So we get a response like this:
                             stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                             intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                             doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                            predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                         }).nullable().optional().describe("Represents the value of a Feature Flag or Setting."),
                     })).nullable().optional().describe("The targeting rules of the Feature Flag or Setting."),
                     percentageEvaluationAttribute: z.string().max(1000).nullable().optional().describe("The user attribute used for percentage evaluation. If not set, it defaults to the `Identifier` user object attribute."),
@@ -1523,6 +1575,7 @@ So we get a response like this:
                             stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                             intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                             doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                            predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                         }).describe("Represents the value of a Feature Flag or Setting."),
                         targetingRules: z.array(z.object({
                             conditions: z.array(z.object({
@@ -1550,6 +1603,7 @@ So we get a response like this:
                                         stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                                         intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                                         doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                                        predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                                     }).describe("Represents the value of a Feature Flag or Setting."),
                                 }).nullable().optional(),
                             })).nullable().optional(),
@@ -1560,6 +1614,7 @@ So we get a response like this:
                                     stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                                     intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                                     doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                                    predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                                 }).describe("Represents the value of a Feature Flag or Setting."),
                             })).nullable().optional().describe("The percentage options from where the evaluation process will choose a value based on the flag's percentage evaluation attribute."),
                             value: z.object({
@@ -1567,6 +1622,7 @@ So we get a response like this:
                                 stringValue: z.string().nullable().optional().describe("The served value in case of a text Setting."),
                                 intValue: z.number().int().nullable().optional().describe("The served value in case of a whole number Setting."),
                                 doubleValue: z.number().nullable().optional().describe("The served value in case of a decimal number Setting."),
+                                predefinedVariationId: z.string().uuid().nullable().optional().describe("The served Variation's identifier."),
                             }).nullable().optional().describe("Represents the value of a Feature Flag or Setting."),
                         })).nullable().optional().describe("The targeting rules of the Feature Flag or Setting."),
                         percentageEvaluationAttribute: z.string().max(1000).nullable().optional().describe("The user attribute used for percentage evaluation. If not set, it defaults to the `Identifier` user object attribute."),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configcat/mcp-server",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "mcpName": "io.github.configcat/mcp-server",
   "type": "module",
   "description": "MCP server exposing ConfigCat Public Management API (products, configs, environments, values v1/v2).",

package/server.json

@@ -6,12 +6,12 @@
     "url": "https://github.com/configcat/mcp-server",
     "source": "github"
   },
-  "version": "0.1.4",
+  "version": "0.1.5",
   "packages": [
     {
       "registryType": "npm",
       "identifier": "@configcat/mcp-server",
-      "version": "0.1.4",
+      "version": "0.1.5",
       "transport": {
         "type": "stdio"
       },