@growthbook/mcp 1.0.2 → 1.1.0

package/README.md

@@ -18,126 +18,5 @@ Use the following env variables to configure the MCP server.
 | GB_API_URL    | Optional | Your GrowthBook API URL. Defaults to `https://api.growthbook.io`. |
 | GB_APP_ORIGIN | Optional | Your GrowthBook app URL Defaults to `https://app.growthbook.io`.  |
 
-Find instructions below to add the MCP server to a client. Any client that supports MCP is also compatible. Consult its documentation for how to add the server.
 
-### Cursor
-
-1. Open **Cursor Settings** → **MCP**
-2. Click **Add new global MCP server**
-3. Add an entry for the GrowthBook MCP, following the pattern below:
-
-```json
-{
-  "mcpServers": {
-    "growthbook": {
-      "command": "npx",
-      "args": ["-y", "@growthbook/mcp"],
-      "env": {
-        "GB_API_KEY": "YOUR_API_KEY",
-        "GB_API_URL": "YOUR_API_URL",
-        "GB_APP_ORIGIN": "YOUR_APP_ORIGIN",
-        "GB_EMAIL": "YOUR_EMAIL"
-      }
-    }
-  }
-}
-```
-
-3. Save the settings.
-
-You should now see a green active status after the server successfully connects!
-
-### VS Code
-
-1. Open **User Settings (JSON)**
-2. Add an MCP entry:
-
-```json
- "mcp": {
-    "servers": {
-      "growthbook": {
-        "command": "npx",
-        "args": [
-          "-y", "@growthbook/mcp"
-        ],
-        "env": {
-          "GB_API_KEY": "YOUR_API_KEY",
-          "GB_API_URL": "YOUR_API_URL",
-          "GB_APP_ORIGIN": "YOUR_APP_ORIGIN",
-          "GB_EMAIL": "YOUR_EMAIL"
-        }
-      }
-    }
-  }
-```
-
-3. Save your settings.
-
-GrowthBook MCP is now ready to use in VS Code.
-
-### Claude Desktop
-
-1. **Open Settings** → **Developer**
-2. Click **Edit Config**
-3. Open `claude_desktop_config.json`
-4. Add the following configuration:
-
-```json
-{
-  "mcpServers": {
-    "growthbook": {
-      "command": "npx",
-      "args": ["-y", "@growthbook/mcp"],
-      "env": {
-        "GB_API_KEY": "YOUR_API_KEY",
-        "GB_API_URL": "YOUR_API_URL",
-        "GB_APP_ORIGIN": "YOUR_APP_ORIGIN",
-        "GB_EMAIL": "YOUR_EMAIL"
-      }
-    }
-  }
-}
-```
-
-5. Save the config and restart Claude
-
-A hammer icon should appear in the chat window, indicating that your GrowthBook MCP server is connected and available!
-
----
-
-## Tools
-
-- **Feature Flags**
-
-  - `create_feature_flag`: Create, add, or wrap an element with a feature flag. Specify key, type, default value, and metadata.
-  - `get_feature_flags`: List all feature flags in your GrowthBook instance.
-  - `get_single_feature_flag`: Fetch details for a specific feature flag by ID.
-  - `get_stale_safe_rollouts`: List all safe rollout rules that have been rolled back or released.
-  - `create_force_rule`: Create a feature flag with a targeting condition.
-  - `generate_flag_types`: Generates types for feature flags
-
-- **Experiments**
-
-  - `get_experiments`: List all experiments in 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**
-
-  - `get_environments`: List all environments (e.g., production, staging) configured in GrowthBook.
-
-- **Projects**
-
-  - `get_projects`: List all projects in your GrowthBook instance.
-
-- **SDK Connections**
-
-  - `get_sdk_connections`: List all SDK connections (how GrowthBook connects to your apps).
-  - `create_sdk_connection`: Create a new SDK connection for your app, specifying language and environment.
-
-- **Documentation Search**
-  - `search_growthbook_docs`: Search the GrowthBook documentation for information on how to use a feature, by keyword or question.
+Add the MCP server to your AI tool of choice. See the [official docs](https://docs.growthbook.io/integrations/mcp) for complete a complete guide.

package/build/index.js

@@ -9,6 +9,7 @@ import { registerSdkConnectionTools } from "./tools/sdk-connections.js";
 import { getApiKey, getApiUrl, getAppOrigin } from "./utils.js";
 import { registerSearchTools } from "./tools/search.js";
 import { registerDefaultsTools } from "./tools/defaults.js";
+import { registerMetricsTools } from "./tools/metrics.js";
 export const baseApiUrl = getApiUrl();
 export const apiKey = getApiKey();
 export const appOrigin = getAppOrigin();
@@ -87,6 +88,13 @@ registerDefaultsTools({
     baseApiUrl,
     apiKey,
 });
+registerMetricsTools({
+    server,
+    baseApiUrl,
+    apiKey,
+    appOrigin,
+    user,
+});
 // Start receiving messages on stdin and sending messages on stdout
 const transport = new StdioServerTransport();
 await server.connect(transport);

package/build/tools/experiments.js

@@ -1,29 +1,61 @@
 import { z } from "zod";
-import { generateLinkToGrowthBook, getDocsMetadata, handleResNotOk, SUPPORTED_FILE_EXTENSIONS, } from "../utils.js";
+import { generateLinkToGrowthBook, getDocsMetadata, handleResNotOk, SUPPORTED_FILE_EXTENSIONS, paginationSchema, } from "../utils.js";
 import { getDefaults } from "./defaults.js";
 export function registerExperimentTools({ server, baseApiUrl, apiKey, appOrigin, user, }) {
     /**
      * Tool: get_experiments
      */
-    server.tool("get_experiments", "Fetches all experiments from the GrowthBook API", {
-        limit: z.number().optional().default(100),
-        offset: z.number().optional().default(0),
-    }, async ({ limit, offset }) => {
+    server.tool("get_experiments", "Fetches experiments from the GrowthBook API", {
+        ...paginationSchema,
+    }, async ({ limit, offset, mostRecent }) => {
         try {
-            const queryParams = new URLSearchParams({
-                limit: limit?.toString(),
-                offset: offset?.toString(),
+            // Default behavior
+            if (!mostRecent || offset > 0) {
+                const defaultQueryParams = new URLSearchParams({
+                    limit: limit.toString(),
+                    offset: offset.toString(),
+                });
+                const defaultRes = await fetch(`${baseApiUrl}/api/v1/experiments?${defaultQueryParams.toString()}`, {
+                    headers: {
+                        Authorization: `Bearer ${apiKey}`,
+                        "Content-Type": "application/json",
+                    },
+                });
+                await handleResNotOk(defaultRes);
+                const data = await defaultRes.json();
+                return {
+                    content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
+                };
+            }
+            // Most recent behavior
+            const countRes = await fetch(`${baseApiUrl}/api/v1/experiments?limit=1`, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`,
+                },
+            });
+            await handleResNotOk(countRes);
+            const countData = await countRes.json();
+            const total = countData.total;
+            const calculatedOffset = Math.max(0, total - limit);
+            const mostRecentQueryParams = new URLSearchParams({
+                limit: limit.toString(),
+                offset: calculatedOffset.toString(),
             });
-            const res = await fetch(`${baseApiUrl}/api/v1/experiments?${queryParams.toString()}`, {
+            const mostRecentRes = await fetch(`${baseApiUrl}/api/v1/experiments?${mostRecentQueryParams.toString()}`, {
                 headers: {
                     Authorization: `Bearer ${apiKey}`,
-                    "Content-Type": "application/json",
                 },
             });
-            await handleResNotOk(res);
-            const data = await res.json();
+            await handleResNotOk(mostRecentRes);
+            const mostRecentData = await mostRecentRes.json();
+            if (mostRecentData.experiments &&
+                Array.isArray(mostRecentData.experiments)) {
+                mostRecentData.experiments = mostRecentData.experiments.reverse();
+            }
             return {
-                content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
+                content: [
+                    { type: "text", text: JSON.stringify(mostRecentData, null, 2) },
+                ],
             };
         }
         catch (error) {

package/build/tools/features.js

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { getDocsMetadata, handleResNotOk, generateLinkToGrowthBook, SUPPORTED_FILE_EXTENSIONS, } from "../utils.js";
+import { getDocsMetadata, handleResNotOk, generateLinkToGrowthBook, SUPPORTED_FILE_EXTENSIONS, paginationSchema, } from "../utils.js";
 import { exec } from "child_process";
 import { getDefaults } from "./defaults.js";
 export function registerFeatureTools({ server, baseApiUrl, apiKey, appOrigin, user, }) {
@@ -98,8 +98,7 @@ export function registerFeatureTools({ server, baseApiUrl, apiKey, appOrigin, us
      * Tool: get_feature_flags
      */
     server.tool("get_feature_flags", "Fetches all feature flags from the GrowthBook API, with optional limit, offset, and project filtering.", {
-        limit: z.number().optional().default(100),
-        offset: z.number().optional().default(0),
+        ...paginationSchema,
     }, async ({ limit, offset }) => {
         try {
             const queryParams = new URLSearchParams({

package/build/tools/metrics.js

@@ -0,0 +1,87 @@
+import { z } from "zod";
+import { generateLinkToGrowthBook, handleResNotOk, paginationSchema, } from "../utils.js";
+export function registerMetricsTools({ server, baseApiUrl, apiKey, appOrigin, }) {
+    /**
+     * Tool: get_metrics
+     */
+    server.tool("get_metrics", "Fetches metrics from the GrowthBook API", {
+        ...paginationSchema,
+    }, async ({ limit, offset }) => {
+        try {
+            const queryParams = new URLSearchParams({
+                limit: limit?.toString(),
+                offset: offset?.toString(),
+            });
+            const metricsRes = await fetch(`${baseApiUrl}/api/v1/metrics?${queryParams.toString()}`, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            await handleResNotOk(metricsRes);
+            const metricsData = await metricsRes.json();
+            const factMetricRes = await fetch(`${baseApiUrl}/api/v1/fact-metrics?${queryParams.toString()}`, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`,
+                    "Content-Type": "application/json",
+                },
+            });
+            await handleResNotOk(factMetricRes);
+            const factMetricData = await factMetricRes.json();
+            const metricData = {
+                metrics: metricsData,
+                factMetrics: factMetricData,
+            };
+            return {
+                content: [
+                    { type: "text", text: JSON.stringify(metricData, null, 2) },
+                ],
+            };
+        }
+        catch (error) {
+            throw new Error(`Error fetching metrics: ${error}`);
+        }
+    });
+    /**
+     * Tool: get_metric
+     */
+    server.tool("get_metric", "Fetches a metric from the GrowthBook API", {
+        metricId: z.string().describe("The ID of the metric to get"),
+    }, async ({ metricId }) => {
+        try {
+            let res;
+            if (metricId.startsWith("fact__")) {
+                res = await fetch(`${baseApiUrl}/api/v1/fact-metrics/${metricId}`, {
+                    headers: {
+                        Authorization: `Bearer ${apiKey}`,
+                        "Content-Type": "application/json",
+                    },
+                });
+            }
+            else {
+                res = await fetch(`${baseApiUrl}/api/v1/metrics/${metricId}`, {
+                    headers: {
+                        Authorization: `Bearer ${apiKey}`,
+                        "Content-Type": "application/json",
+                    },
+                });
+            }
+            await handleResNotOk(res);
+            const data = await res.json();
+            const linkToGrowthBook = generateLinkToGrowthBook(appOrigin, data.factMetric ? "fact-metrics" : "metric", metricId);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify(data, null, 2) +
+                            `\n**Critical** Show the user the link to the metric in GrowthBook: [View the metric in GrowthBook](${linkToGrowthBook})
+          `,
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            throw new Error(`Error fetching metric: ${error}`);
+        }
+    });
+}

package/build/tools/projects.js

@@ -1,12 +1,10 @@
-import { z } from "zod";
-import { handleResNotOk } from "../utils.js";
+import { handleResNotOk, paginationSchema, } from "../utils.js";
 /**
  * Tool: get_projects
  */
 export function registerProjectTools({ server, baseApiUrl, apiKey, }) {
     server.tool("get_projects", "Fetches all projects from the GrowthBook API", {
-        limit: z.number().optional().default(100),
-        offset: z.number().optional().default(0),
+        ...paginationSchema,
     }, async ({ limit, offset }) => {
         const queryParams = new URLSearchParams({
             limit: limit.toString(),

package/build/tools/sdk-connections.js

@@ -1,12 +1,11 @@
 import { z } from "zod";
-import { handleResNotOk } from "../utils.js";
+import { handleResNotOk, paginationSchema, } from "../utils.js";
 export function registerSdkConnectionTools({ server, baseApiUrl, apiKey, }) {
     /**
      * Tool: get_sdk_connections
      */
     server.tool("get_sdk_connections", "Get all SDK connections. SDK connections are how GrowthBook connects to an app. Users need the client key to fetch features and experiments from the API.", {
-        limit: z.number().optional().default(100),
-        offset: z.number().optional().default(0),
+        ...paginationSchema,
     }, async ({ limit, offset }) => {
         try {
             const queryParams = new URLSearchParams({

package/build/utils.js

@@ -1,3 +1,4 @@
+import { z } from "zod";
 import { getFeatureFlagDocs } from "./docs.js";
 // Shared file extension enum for all MCP tools
 export const SUPPORTED_FILE_EXTENSIONS = [
@@ -172,3 +173,21 @@ export async function searchGrowthBookDocs(query) {
 export function generateLinkToGrowthBook(appOrigin, resource, id) {
     return `${appOrigin}/${resource}/${id}`;
 }
+// Reusable pagination schema for GrowthBook API tools
+export const paginationSchema = {
+    limit: z
+        .number()
+        .min(1)
+        .max(100)
+        .default(100)
+        .describe("The number of items to fetch (1-100)"),
+    offset: z
+        .number()
+        .min(0)
+        .default(0)
+        .describe("The number of items to skip. For example, set to 100 to fetch the second page with default limit. Note: The API returns items in chronological order (oldest first) by default."),
+    mostRecent: z
+        .boolean()
+        .default(false)
+        .describe("When true, fetches the most recent items and returns them newest-first. When false (default), returns oldest items first."),
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@growthbook/mcp",
-  "version": "1.0.2",
-  "description": "",
+  "version": "1.1.0",
+  "description": "MCP Server for interacting with GrowthBook",
   "access": "public",
   "homepage": "https://github.com/growthbook/growthbook-mcp",
   "scripts": {
@@ -17,7 +17,13 @@
   "files": [
     "build"
   ],
-  "keywords": [],
+  "keywords": [
+    "growthbook",
+    "mcp",
+    "modelcontextprotocol",
+    "featureflags",
+    "experiments"
+  ],
   "author": "GrowthBook",
   "license": "MIT",
   "packageManager": "pnpm@10.6.1",