feat(api): pre-launch SDK release

Author: stainless-app[bot]

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
           URL: https://pkg.stainless.com/s?subpackage=mcp-server
           AUTH: ${{ steps.github-oidc.outputs.github_token }}
           SHA: ${{ github.sha }}
-          BUILD_PATH: packages/mcp-server/dist
+          BASE_PATH: packages/mcp-server
         run: ./scripts/utils/upload-artifact.sh
   test:
     timeout-minutes: 10

.github/workflows/publish-npm.yml

@@ -16,6 +16,8 @@ jobs:
   publish:
     name: publish
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
 
     steps:
       - uses: actions/checkout@v4
@@ -39,3 +41,10 @@ jobs:
           yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }"
         env:
           NPM_TOKEN: ${{ secrets.FLOWGLAD_NPM_TOKEN || secrets.NPM_TOKEN }}
+
+      - name: Upload MCP Server DXT GitHub release asset
+        run: |
+          gh release upload ${{ github.event.release.tag_name }} \
+            packages/mcp-server/flowglad_node_api.mcpb
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -7,4 +7,6 @@ dist
 dist-deno
 /*.tgz
 .idea/
-
+.eslintcache
+dist-bundle
+*.mcpb

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/flowglad%2Fflowglad-0cf7bce0c17d6f5a651950ab9f46224548af6b420a8a18883ae357c834ab6148.yml
-openapi_spec_hash: 4d78e958c164eaa79116965799ff10c7
-config_hash: 5cd4df36fa4da9901706710955ea260e
+configured_endpoints: 45
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/flowglad%2Fflowglad-a1eeb4fac4d6f2e5a1bed0a6ef5abfc4172e8d989c24343860b8a07a389ea65b.yml
+openapi_spec_hash: 1bd6007e37eeb62e1dc85da4f939ed1d
+config_hash: b3cf56eeb5f18b49019b9be6e30263c0

api.md

@@ -1,14 +1,30 @@
+# Shared
+
+Types:
+
+- <code><a href="./src/resources/shared.ts">BillingAddress</a></code>
+- <code><a href="./src/resources/shared.ts">NonRenewingSubscriptionRecord</a></code>
+- <code><a href="./src/resources/shared.ts">PaymentMethodClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">PricingModelDetailsRecord</a></code>
+- <code><a href="./src/resources/shared.ts">PurchaseInvoiceClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">StandaloneInvoiceClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">StandardSubscriptionRecord</a></code>
+- <code><a href="./src/resources/shared.ts">StaticInvoiceLineItemClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">SubscriptionInvoiceClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">ToggleFeatureClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">UsageCreditGrantFeatureClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">UsageInvoiceLineItemClientSelectSchema</a></code>
+- <code><a href="./src/resources/shared.ts">UsageMeterClientSelectSchema</a></code>
+
 # Invoices
 
 Types:
 
-- <code><a href="./src/resources/invoices.ts">InvoiceCreateResponse</a></code>
 - <code><a href="./src/resources/invoices.ts">InvoiceRetrieveResponse</a></code>
 - <code><a href="./src/resources/invoices.ts">InvoiceListResponse</a></code>
 
 Methods:
 
-- <code title="post /api/v1/invoices">client.invoices.<a href="./src/resources/invoices.ts">create</a>({ ...params }) -> InvoiceCreateResponse</code>
 - <code title="get /api/v1/invoices/{id}">client.invoices.<a href="./src/resources/invoices.ts">retrieve</a>(id) -> InvoiceRetrieveResponse</code>
 - <code title="get /api/v1/invoices">client.invoices.<a href="./src/resources/invoices.ts">list</a>({ ...params }) -> InvoiceListResponse</code>
 
@@ -24,30 +40,36 @@ Methods:
 - <code title="get /api/v1/invoice-line-items/{id}">client.invoiceLineItems.<a href="./src/resources/invoice-line-items.ts">retrieve</a>(id) -> InvoiceLineItemRetrieveResponse</code>
 - <code title="get /api/v1/invoice-line-items">client.invoiceLineItems.<a href="./src/resources/invoice-line-items.ts">list</a>({ ...params }) -> InvoiceLineItemListResponse</code>
 
-# Catalogs
+# PricingModels
 
 Types:
 
-- <code><a href="./src/resources/catalogs.ts">CatalogCreateResponse</a></code>
-- <code><a href="./src/resources/catalogs.ts">CatalogRetrieveResponse</a></code>
-- <code><a href="./src/resources/catalogs.ts">CatalogUpdateResponse</a></code>
-- <code><a href="./src/resources/catalogs.ts">CatalogListResponse</a></code>
-- <code><a href="./src/resources/catalogs.ts">CatalogCloneResponse</a></code>
-- <code><a href="./src/resources/catalogs.ts">CatalogRetrieveDefaultResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelClientSelectSchema</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelCreateResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelRetrieveResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelUpdateResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelListResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelCloneResponse</a></code>
+- <code><a href="./src/resources/pricing-models.ts">PricingModelRetrieveDefaultResponse</a></code>
 
 Methods:
 
-- <code title="post /api/v1/catalogs">client.catalogs.<a href="./src/resources/catalogs.ts">create</a>({ ...params }) -> CatalogCreateResponse</code>
-- <code title="get /api/v1/catalogs/{id}">client.catalogs.<a href="./src/resources/catalogs.ts">retrieve</a>(id) -> CatalogRetrieveResponse</code>
-- <code title="put /api/v1/catalogs/{id}">client.catalogs.<a href="./src/resources/catalogs.ts">update</a>(id, { ...params }) -> CatalogUpdateResponse</code>
-- <code title="get /api/v1/catalogs">client.catalogs.<a href="./src/resources/catalogs.ts">list</a>({ ...params }) -> CatalogListResponse</code>
-- <code title="post /api/v1/catalogs/{id}/clone">client.catalogs.<a href="./src/resources/catalogs.ts">clone</a>(id, { ...params }) -> CatalogCloneResponse</code>
-- <code title="get /api/v1/catalogs/default">client.catalogs.<a href="./src/resources/catalogs.ts">retrieveDefault</a>() -> CatalogRetrieveDefaultResponse</code>
+- <code title="post /api/v1/pricing-models">client.pricingModels.<a href="./src/resources/pricing-models.ts">create</a>({ ...params }) -> PricingModelCreateResponse</code>
+- <code title="get /api/v1/pricing-models/{id}">client.pricingModels.<a href="./src/resources/pricing-models.ts">retrieve</a>(id) -> PricingModelRetrieveResponse</code>
+- <code title="put /api/v1/pricing-models/{id}">client.pricingModels.<a href="./src/resources/pricing-models.ts">update</a>(id, { ...params }) -> PricingModelUpdateResponse</code>
+- <code title="get /api/v1/pricing-models">client.pricingModels.<a href="./src/resources/pricing-models.ts">list</a>({ ...params }) -> PricingModelListResponse</code>
+- <code title="post /api/v1/pricing-models/{id}/clone">client.pricingModels.<a href="./src/resources/pricing-models.ts">clone</a>(id, { ...params }) -> PricingModelCloneResponse</code>
+- <code title="get /api/v1/pricing-models/default">client.pricingModels.<a href="./src/resources/pricing-models.ts">retrieveDefault</a>() -> PricingModelRetrieveDefaultResponse</code>
 
 # CheckoutSessions
 
 Types:
 
+- <code><a href="./src/resources/checkout-sessions.ts">ActivateSubscriptionCheckoutSessionClientSelectSchema</a></code>
+- <code><a href="./src/resources/checkout-sessions.ts">AddPaymentMethodCheckoutSessionClientSelectSchema</a></code>
+- <code><a href="./src/resources/checkout-sessions.ts">InvoiceCheckoutSessionClientSelectSchema</a></code>
+- <code><a href="./src/resources/checkout-sessions.ts">ProductCheckoutSessionClientSelectSchema</a></code>
+- <code><a href="./src/resources/checkout-sessions.ts">PurchaseCheckoutSessionClientSelectSchema</a></code>
 - <code><a href="./src/resources/checkout-sessions.ts">CheckoutSessionCreateResponse</a></code>
 - <code><a href="./src/resources/checkout-sessions.ts">CheckoutSessionRetrieveResponse</a></code>
 - <code><a href="./src/resources/checkout-sessions.ts">CheckoutSessionListResponse</a></code>
@@ -62,6 +84,7 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/products.ts">ProductClientSelectSchema</a></code>
 - <code><a href="./src/resources/products.ts">ProductCreateResponse</a></code>
 - <code><a href="./src/resources/products.ts">ProductRetrieveResponse</a></code>
 - <code><a href="./src/resources/products.ts">ProductUpdateResponse</a></code>
@@ -78,6 +101,9 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/prices.ts">SinglePaymentPriceClientSelectSchema</a></code>
+- <code><a href="./src/resources/prices.ts">SubscriptionPriceClientSelectSchema</a></code>
+- <code><a href="./src/resources/prices.ts">UsagePriceClientSelectSchema</a></code>
 - <code><a href="./src/resources/prices.ts">PriceCreateResponse</a></code>
 - <code><a href="./src/resources/prices.ts">PriceUpdateResponse</a></code>
 - <code><a href="./src/resources/prices.ts">PriceListResponse</a></code>
@@ -92,6 +118,9 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/discounts.ts">DefaultDiscountClientSelectSchema</a></code>
+- <code><a href="./src/resources/discounts.ts">ForeverDiscountClientSelectSchema</a></code>
+- <code><a href="./src/resources/discounts.ts">NumberOfPaymentsDiscountClientSelectSchema</a></code>
 - <code><a href="./src/resources/discounts.ts">DiscountCreateResponse</a></code>
 - <code><a href="./src/resources/discounts.ts">DiscountRetrieveResponse</a></code>
 - <code><a href="./src/resources/discounts.ts">DiscountUpdateResponse</a></code>
@@ -108,6 +137,9 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/customers.ts">CustomerClientSelectSchema</a></code>
+- <code><a href="./src/resources/customers.ts">ToggleSubscriptionItemFeatureRecord</a></code>
+- <code><a href="./src/resources/customers.ts">UsageCreditGrantSubscriptionItemFeatureClientSelectSchema</a></code>
 - <code><a href="./src/resources/customers.ts">CustomerCreateResponse</a></code>
 - <code><a href="./src/resources/customers.ts">CustomerRetrieveResponse</a></code>
 - <code><a href="./src/resources/customers.ts">CustomerUpdateResponse</a></code>
@@ -126,6 +158,7 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/payments.ts">PaymentClientSelectSchema</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentRetrieveResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentListResponse</a></code>
 - <code><a href="./src/resources/payments.ts">PaymentRefundResponse</a></code>

packages/mcp-server/README.md

@@ -170,7 +170,7 @@ http://localhost:3000?client=cursor&capability=tool-name-length%3D40
 import { server, endpoints, init } from "@flowglad/node-mcp/server";
 
 // import a specific tool
-import createInvoices from "@flowglad/node-mcp/tools/invoices/create-invoices";
+import retrieveInvoices from "@flowglad/node-mcp/tools/invoices/retrieve-invoices";
 
 // initialize the server and all endpoints
 init({ server, endpoints });
@@ -195,7 +195,7 @@ const myCustomEndpoint = {
 };
 
 // initialize the server with your custom endpoints
-init({ server: myServer, endpoints: [createInvoices, myCustomEndpoint] });
+init({ server: myServer, endpoints: [retrieveInvoices, myCustomEndpoint] });
 ```
 
 ## Available Tools
@@ -204,7 +204,6 @@ The following tools are available in this MCP server.
 
 ### Resource `invoices`:
 
-- `create_invoices` (`write`): Create Invoice
 - `retrieve_invoices` (`read`): Get Invoice
 - `list_invoices` (`read`): List Invoices
 
@@ -213,14 +212,14 @@ The following tools are available in this MCP server.
 - `retrieve_invoice_line_items` (`read`): Get Invoice Line Item
 - `list_invoice_line_items` (`read`): List Invoice Line Items
 
-### Resource `catalogs`:
+### Resource `pricing_models`:
 
-- `create_catalogs` (`write`): Create Catalog
-- `retrieve_catalogs` (`read`): Get Catalog
-- `update_catalogs` (`write`): Update Catalog
-- `list_catalogs` (`read`): List Catalogs
-- `clone_catalogs` (`write`): Clone a Catalog
-- `retrieve_default_catalogs` (`read`): Get Default Catalog for Organization
+- `create_pricing_models` (`write`): Create Pricing Model
+- `retrieve_pricing_models` (`read`): Get Pricing Model
+- `update_pricing_models` (`write`): Update Pricing Model
+- `list_pricing_models` (`read`): List Pricing Models
+- `clone_pricing_models` (`write`): Clone a PricingModel
+- `retrieve_default_pricing_models` (`read`): Get Default Pricing Model for Organization
 
 ### Resource `checkout_sessions`:
 
@@ -272,7 +271,7 @@ The following tools are available in this MCP server.
 - `create_subscriptions` (`write`): Create Subscription
 - `retrieve_subscriptions` (`read`): Get Subscription
 - `list_subscriptions` (`read`): List Subscriptions
-- `adjust_subscriptions` (`write`): Adjust a Subscription
+- `adjust_subscriptions` (`write`): Note: Immediate adjustments are in private preview (Please let us know you use this feature: https://github.com/flowglad/flowglad/issues/616). Adjustments at the end of the current billing period are generally available.
 - `cancel_subscriptions` (`write`): Cancel a Subscription
 
 ### Resource `usage_events`:

packages/mcp-server/build

@@ -30,3 +30,27 @@ cp tsconfig.dist-src.json dist/src/tsconfig.json
 chmod +x dist/index.js
 
 DIST_PATH=./dist PKG_IMPORT_PATH=@flowglad/node-mcp/ node ../../scripts/utils/postprocess-files.cjs
+
+# mcp bundle
+rm -rf dist-bundle flowglad_node_api.mcpb; mkdir dist-bundle
+
+# copy package.json
+PKG_JSON_PATH=../../packages/mcp-server/package.json node ../../scripts/utils/make-dist-package-json.cjs > dist-bundle/package.json
+
+# copy files
+node scripts/copy-bundle-files.cjs
+
+# install runtime deps
+cd dist-bundle
+npm install
+cd ..
+
+# pack bundle
+cp manifest.json dist-bundle
+
+npx mcpb pack dist-bundle flowglad_node_api.mcpb
+
+npx mcpb sign flowglad_node_api.mcpb --self-signed
+
+# clean up
+rm -rf dist-bundle

packages/mcp-server/manifest.json

@@ -0,0 +1,43 @@
+{
+  "dxt_version": "0.2",
+  "name": "@flowglad/node-mcp",
+  "version": "0.21.0",
+  "description": "The official MCP Server for the Flowglad API",
+  "author": {
+    "name": "Flowglad",
+    "email": "[email protected]"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flowglad/flowglad-node.git"
+  },
+  "homepage": "https://github.com/flowglad/flowglad-node/tree/main/packages/mcp-server#readme",
+  "documentation": "https://docs.flowglad.com",
+  "server": {
+    "type": "node",
+    "entry_point": "index.js",
+    "mcp_config": {
+      "command": "node",
+      "args": ["${__dirname}/index.js"],
+      "env": {
+        "FLOWGLAD_SECRET_KEY": "${user_config.FLOWGLAD_SECRET_KEY}"
+      }
+    }
+  },
+  "user_config": {
+    "FLOWGLAD_SECRET_KEY": {
+      "title": "api_key",
+      "description": "API key for accessing the Flowglad API",
+      "required": true,
+      "type": "string"
+    }
+  },
+  "tools": [],
+  "tools_generated": true,
+  "compatibility": {
+    "runtimes": {
+      "node": ">=18.0.0"
+    }
+  },
+  "keywords": ["api"]
+}

packages/mcp-server/package.json

@@ -47,6 +47,7 @@
     "mcp-server": "dist/index.js"
   },
   "devDependencies": {
+    "@anthropic-ai/mcpb": "^1.1.0",
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.3",
     "@types/jest": "^29.4.0",

packages/mcp-server/scripts/copy-bundle-files.cjs

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const path = require('path');
+const pkgJson = require('../dist-bundle/package.json');
+
+const distDir = path.resolve(__dirname, '..', 'dist');
+const distBundleDir = path.resolve(__dirname, '..', 'dist-bundle');
+const distBundlePkgJson = path.join(distBundleDir, 'package.json');
+
+async function* walk(dir) {
+  for await (const d of await fs.promises.opendir(dir)) {
+    const entry = path.join(dir, d.name);
+    if (d.isDirectory()) yield* walk(entry);
+    else if (d.isFile()) yield entry;
+  }
+}
+
+async function copyFiles() {
+  // copy runtime files
+  for await (const file of walk(distDir)) {
+    if (!/[cm]?js$/.test(file)) continue;
+    const dest = path.join(distBundleDir, path.relative(distDir, file));
+    await fs.promises.mkdir(path.dirname(dest), { recursive: true });
+    await fs.promises.copyFile(file, dest);
+  }
+
+  // replace package.json reference with local reference
+  for (const dep in pkgJson.dependencies) {
+    if (dep === '@flowglad/node') {
+      pkgJson.dependencies[dep] = 'file:../../../dist/';
+    }
+  }
+
+  await fs.promises.writeFile(distBundlePkgJson, JSON.stringify(pkgJson, null, 2));
+}
+
+copyFiles();