@growthbook/mcp 0.1.2 → 0.1.3

package/README.md

@@ -122,6 +122,9 @@ A hammer icon should appear in the chat window, indicating that your GrowthBook
   - `get_experiment`: Fetch details for a specific experiment by ID.
   - `get_attributes`: List all user attributes tracked in GrowthBook (useful for targeting).
   - `create_experiment`: Creates a feature-flag based experiment.
+  - `get_defaults`: Get default values for experiments including hypothesis, description, datasource, and assignment query. (Runs automatically when the create experiment tool is called.)
+  - `create_defaults`: Set custom default values for experiments that will be used when creating new experiments.
+  - `clear_user_defaults`: Clear user-defined defaults and revert to automatic defaults.
 
 - **Environments**
 

package/build/tools/defaults.js

@@ -1,10 +1,12 @@
 import { handleResNotOk } from "../utils.js";
 import envPaths from "env-paths";
-import { writeFile, readFile } from "fs/promises";
+import { writeFile, readFile, mkdir, unlink } from "fs/promises";
 import { join } from "path";
+import { z } from "zod";
 const paths = envPaths("growthbook-mcp"); // Use your app name
 const experimentDefaultsDir = paths.config; // This is the recommended config directory
 const experimentDefaultsFile = join(experimentDefaultsDir, "experiment-defaults.json");
+const userDefaultsFile = join(experimentDefaultsDir, "user-defaults.json");
 export async function createDefaults(apiKey, baseApiUrl) {
     try {
         const experimentsResponse = await fetch(`${baseApiUrl}/api/v1/experiments`, {
@@ -42,6 +44,10 @@ export async function createDefaults(apiKey, baseApiUrl) {
                 datasource: "",
                 assignmentQuery,
                 environments,
+                filePaths: {
+                    experimentDefaultsFile,
+                    userDefaultsFile,
+                },
                 timestamp: new Date().toISOString(),
             };
         }
@@ -121,6 +127,10 @@ export async function createDefaults(apiKey, baseApiUrl) {
             datasource: mostFrequentDS.ds,
             assignmentQuery: mostFrequentDS.aq,
             environments,
+            filePaths: {
+                experimentDefaultsFile,
+                userDefaultsFile,
+            },
             timestamp: new Date().toISOString(),
         };
     }
@@ -128,16 +138,94 @@ export async function createDefaults(apiKey, baseApiUrl) {
         throw error;
     }
 }
+async function getUserDefaults() {
+    try {
+        const userDefaultsData = await readFile(userDefaultsFile, "utf8");
+        return JSON.parse(userDefaultsData);
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return null;
+        }
+        throw error;
+    }
+}
 export async function getDefaults(apiKey, baseApiUrl) {
+    // First check for user-defined defaults
+    const userDefaults = await getUserDefaults();
+    if (userDefaults) {
+        // User has set defaults, use them for datasource/assignment/environments
+        // But still get the automatic defaults for names/hypotheses/descriptions
+        let autoDefaults = {
+            name: [],
+            hypothesis: [],
+            description: [],
+        };
+        try {
+            // Try to get existing auto-generated defaults for name/hypothesis/description
+            const experimentDefaultsData = await readFile(experimentDefaultsFile, "utf8");
+            const parsedExperimentDefaults = JSON.parse(experimentDefaultsData);
+            if (parsedExperimentDefaults &&
+                new Date(parsedExperimentDefaults.timestamp).getTime() >
+                    new Date().getTime() - 1000 * 60 * 60 * 24 * 30 // 30 days
+            ) {
+                autoDefaults = {
+                    name: parsedExperimentDefaults.name || [],
+                    hypothesis: parsedExperimentDefaults.hypothesis || [],
+                    description: parsedExperimentDefaults.description || [],
+                };
+            }
+            else {
+                // Re-generate auto defaults if expired
+                const generatedDefaults = await createDefaults(apiKey, baseApiUrl);
+                await mkdir(experimentDefaultsDir, { recursive: true });
+                await writeFile(experimentDefaultsFile, JSON.stringify(generatedDefaults, null, 2));
+                autoDefaults = {
+                    name: generatedDefaults.name,
+                    hypothesis: generatedDefaults.hypothesis,
+                    description: generatedDefaults.description,
+                };
+            }
+        }
+        catch (error) {
+            if (error.code === "ENOENT") {
+                // Generate new auto defaults
+                const generatedDefaults = await createDefaults(apiKey, baseApiUrl);
+                await mkdir(experimentDefaultsDir, { recursive: true });
+                await writeFile(experimentDefaultsFile, JSON.stringify(generatedDefaults, null, 2));
+                autoDefaults = {
+                    name: generatedDefaults.name,
+                    hypothesis: generatedDefaults.hypothesis,
+                    description: generatedDefaults.description,
+                };
+            }
+        }
+        // Combine user defaults with auto defaults
+        return {
+            name: autoDefaults.name || [],
+            hypothesis: autoDefaults.hypothesis || [],
+            description: autoDefaults.description || [],
+            datasource: userDefaults.datasourceId,
+            assignmentQuery: userDefaults.assignmentQueryId,
+            environments: userDefaults.environments,
+            filePaths: {
+                experimentDefaultsFile,
+                userDefaultsFile,
+            },
+            timestamp: new Date().toISOString(),
+        };
+    }
+    // No user defaults, use fully automatic defaults
     let experimentDefaults;
     try {
         const experimentDefaultsData = await readFile(experimentDefaultsFile, "utf8");
         let parsedExperimentDefaults = JSON.parse(experimentDefaultsData);
         if (!parsedExperimentDefaults ||
-            parsedExperimentDefaults.timestamp <
+            new Date(parsedExperimentDefaults.timestamp).getTime() <
                 new Date().getTime() - 1000 * 60 * 60 * 24 * 30 // 30 days
         ) {
             const generatedExperimentDefaults = await createDefaults(apiKey, baseApiUrl);
+            await mkdir(experimentDefaultsDir, { recursive: true });
             await writeFile(experimentDefaultsFile, JSON.stringify(generatedExperimentDefaults, null, 2));
             parsedExperimentDefaults = generatedExperimentDefaults;
         }
@@ -147,6 +235,7 @@ export async function getDefaults(apiKey, baseApiUrl) {
         if (error.code === "ENOENT") {
             // experimentDefaultsFile does not exist, generate new defaults
             const generatedExperimentDefaults = await createDefaults(apiKey, baseApiUrl);
+            await mkdir(experimentDefaultsDir, { recursive: true });
             await writeFile(experimentDefaultsFile, JSON.stringify(generatedExperimentDefaults, null, 2));
             experimentDefaults = generatedExperimentDefaults;
         }
@@ -163,7 +252,70 @@ export async function registerDefaultsTools({ server, baseApiUrl, apiKey, }) {
     server.tool("get_defaults", "Get the default values for experiments, including hypothesis, description, datasource, assignment query, and environments.", {}, async () => {
         const defaults = await getDefaults(apiKey, baseApiUrl);
         return {
-            content: [{ type: "text", text: JSON.stringify(defaults, null, 2) }],
+            content: [
+                {
+                    type: "text",
+                    text: JSON.stringify(defaults, null, 2),
+                },
+            ],
         };
     });
+    server.tool("set_user_defaults", "Set user-defined defaults for datasource, assignment query, and environments. These will override the automatic defaults for these fields.", {
+        datasourceId: z.string().describe("The data source ID to use as default"),
+        assignmentQueryId: z
+            .string()
+            .describe("The assignment query ID to use as default"),
+        environments: z
+            .array(z.string())
+            .describe("List of environment IDs to use as defaults"),
+    }, async ({ datasourceId, assignmentQueryId, environments }) => {
+        try {
+            const userDefaults = {
+                datasourceId,
+                assignmentQueryId,
+                environments,
+                timestamp: new Date().toISOString(),
+            };
+            await mkdir(experimentDefaultsDir, { recursive: true });
+            await writeFile(userDefaultsFile, JSON.stringify(userDefaults, null, 2));
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: `User defaults have been saved:\n\n${JSON.stringify(userDefaults, null, 2)} to ${userDefaultsFile}\n\nThese will be used when creating new experiments.`,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            throw new Error(`Error setting user defaults: ${error}`);
+        }
+    });
+    server.tool("clear_user_defaults", "Clear user-defined defaults and revert to automatic defaults.", {}, async () => {
+        try {
+            await readFile(userDefaultsFile, "utf8");
+            await unlink(userDefaultsFile);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: "User defaults have been cleared. The system will now use automatic defaults.",
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            if (error.code === "ENOENT") {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: "No user defaults were set.",
+                        },
+                    ],
+                };
+            }
+            throw new Error(`Error clearing user defaults: ${error}`);
+        }
+    });
 }

package/build/tools/experiments.js

@@ -261,8 +261,8 @@ export function registerExperimentTools({ server, baseApiUrl, apiKey, appOrigin,
                 },
                 body: JSON.stringify(flagPayload),
             });
-            const flagData = await flagRes.json();
             await handleResNotOk(flagRes);
+            const flagData = await flagRes.json();
             const experimentLink = generateLinkToGrowthBook(appOrigin, "experiment", experimentData.experiment.id);
             const flagLink = generateLinkToGrowthBook(appOrigin, "features", flagData.feature.id);
             const { stub, docs, language } = getDocsMetadata(fileExtension);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@growthbook/mcp",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "",
   "access": "public",
   "homepage": "https://github.com/growthbook/growthbook-mcp",