@W-21105798: Scaffold Custom API MCP Tool by wei-liu-sf · Pull Request #204 · SalesforceCommerceCloud/b2c-developer-tooling

wei-liu-sf · 2026-02-24T19:38:53Z

Summary

Implementation of Scaffold Custom API MCP Tool

Testing

Restart the local B2C-DX-MCP

Dependencies

No net-new third-party dependencies were added
If net-new third-party dependencies were added, rationale/discussion is included and 3pl-approved is set by a maintainer

Tests pass (pnpm test)
Code is formatted (pnpm run format)

patricksullivansf · 2026-02-24T20:55:43Z

packages/b2c-dx-mcp/src/commands/mcp.ts

    const flagConfig = {
      ...extractInstanceFlags(this.flags as Record<string, unknown>),
      ...mrt.config,
+      workingDirectory: this.flags['working-directory'],


working-directory is deprecated. See #199.

also see prior #160 which exposes workingDirectory/projectDirectory in thecontext.services.getWorkingDirectory() passed to each tool. Not sure which approach is better, but we should standardize on a best one.

packages/b2c-dx-mcp/src/tools/scapi/scapi-custom-api-scaffold.ts

patricksullivansf · 2026-02-24T20:59:22Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-custom-api-scaffold.ts

+          .min(1)
+          .nullish()
+          .describe(
+            'Cartridge name that will contain the API. Optional; omit to use the first cartridge found under working directory (--working-directory or SFCC_WORKING_DIRECTORY).',


deprecated flags and env vars. see #199

As I have some questions related to workingDirectory deprecation, I will leave this as is for now and follow up with Charles when he comes back.

My preference is to follow the pattern used in all the other tools for now. If later after discussing we decide we need to change our pattern, having everything consistent will make that change easier. Insisting on showing a flag that is correctly marked deprecated is going to confuse our users.

Since all other places are changed, can we change this to project directory as well to keep them the same?

resolved for now. will revisit.

packages/b2c-dx-mcp/README.md

yhsieh1 · 2026-02-24T20:42:04Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+export function createScaffoldCustomApiTool(loadServices: () => Services): McpTool {
+  return createToolAdapter<ScaffoldCustomApiInput, ScaffoldCustomApiOutput>(
+    {
+      name: 'scapi_customapi_scaffold',


We have scapi_custom_apis_status tool, can we unify the tool name? Maybe scapi_custom_api_scaffold

This name "scapi_custom_api_scaffold" is following the LLD. Once LLD is updated, will update here.

@wei-liu-sf I corrected the name in LLD so that it matches the naming with other scapi tools. Please update it to scapi_custom_api_scaffold. Thank you.

yhsieh1 · 2026-02-24T21:07:42Z

packages/b2c-dx-mcp/src/commands/mcp.ts

    const flagConfig = {
      ...extractInstanceFlags(this.flags as Record<string, unknown>),
      ...mrt.config,
+      workingDirectory: this.flags['working-directory'],


getBaseConfigOptions() already supplies workingDirectory so we do not need it here again.

yhsieh1 · 2026-02-24T21:22:01Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+  /** Short description of the API. Default: "A custom B2C Commerce API" */
+  apiDescription?: string;
+  /** Include example GET/POST endpoints in schema and script. Default: true */
+  includeExampleEndpoints?: boolean;


Wonder when agent will set this to false? Do we need this input?

it's default to true. I can remove it.

yhsieh1 · 2026-02-24T21:23:31Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+  /** Output directory override. Default: scaffold default or project root */
+  outputDir?: string;
+  /** If true, preview only (no files written). Default: false */
+  dryRun?: boolean;


What will happen when dryRun is true? Do we need this?

yhsieh1 · 2026-02-24T21:26:15Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+      name: 'scapi_customapi_scaffold',
+      description: `Generate a new custom SCAPI endpoint (OAS 3.0 schema, api.json, script.js) in an existing cartridge. \
+       Uses the same scaffold as CLI: b2c scaffold generate custom-api. \
+       Required: apiName (kebab-case). Optional: cartridgeName (defaults to first cartridge found in project), apiType (shopper|admin), apiDescription, includeExampleEndpoints, projectRoot, outputDir, dryRun, force. \


Description can be improved to avoid duplicated inputs info that is specified in the input schema. Also we probably can skip the mention of CLI since that seems not help agent to use the tool.

packages/b2c-dx-mcp/src/tools/scapi/scapi-custom-api-scaffold.ts

yhsieh1 · 2026-02-24T21:53:49Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+              dryRun: args.dryRun ?? false,
+              files: [],
+              error:
+                'No cartridges found in project. Add a cartridge (directory with .project file) or pass cartridgeName explicitly.',


Can we give more details so that agent knows how to add a cartridge project?

Sure, will do

packages/b2c-tooling-sdk/src/operations/code/cartridges.ts

packages/b2c-dx-mcp/README.md

yhsieh1 · 2026-02-25T22:37:38Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-custom-api-scaffold.ts

+ * Generates a new custom SCAPI endpoint using the SDK's custom-api scaffold
+ * (schema.yaml, api.json, script.js). Mirrors CLI: b2c scaffold generate custom-api.
+ *
+ * @module tools/scapi/scapi-customapi-scaffold


Can we update file name as well?

yhsieh1 · 2026-02-25T22:39:19Z

packages/b2c-dx-mcp/src/tools/scapi/scapi-customapi-scaffold.ts

+    {
+      name: 'scapi_custom_api_scaffold',
+      description: `Generate a new custom SCAPI endpoint (OAS 3.0 schema, api.json, script.js) in an existing cartridge. \
+       Uses the same scaffold as CLI: b2c scaffold generate custom-api. \


Can we remove LCI from the description? We should try to keep description short and simple. Mention of CLI might confuse agent.

yhsieh1

LGTM but seems coverage dropped below threshold.

patricksullivansf

thank you! after it merges i'll do a fast follow to address the clean up we discussed

initial changes for custom api

3a017bb

wei-liu-sf requested review from clavery, patricksullivansf and yhsieh1 as code owners February 24, 2026 19:38

wei-liu-sf marked this pull request as draft February 24, 2026 19:39

patricksullivansf reviewed Feb 24, 2026

View reviewed changes

yhsieh1 reviewed Feb 24, 2026

View reviewed changes

packages/b2c-tooling-sdk/src/operations/code/cartridges.ts Show resolved Hide resolved

yhsieh1 reviewed Feb 24, 2026

View reviewed changes

packages/b2c-dx-mcp/README.md Show resolved Hide resolved

wei-liu-sf added 4 commits February 24, 2026 18:15

remove two parameters

90afd00

address review comments

3dff85f

fix comment

e8b0ba5

merge

18ff9a5

yhsieh1 reviewed Feb 25, 2026

View reviewed changes

wei-liu-sf added 3 commits February 25, 2026 19:20

clean up

61a74d3

add docs

b16fa6c

fix test

b1101d3

wei-liu-sf marked this pull request as ready for review February 26, 2026 01:28

wei-liu-sf added 3 commits February 25, 2026 20:38

improve code coverage

bfc9872

fix comment

997e2fa

fix message

e36ec51

yhsieh1 approved these changes Feb 26, 2026

View reviewed changes

yhsieh1 self-requested a review February 26, 2026 01:58

test coverage

bdadb79

yhsieh1 approved these changes Feb 26, 2026

View reviewed changes

patricksullivansf approved these changes Feb 26, 2026

View reviewed changes

wei-liu-sf merged commit 12bd455 into main Feb 26, 2026
4 checks passed

wei-liu-sf deleted the W-21105798.wei-liu-sf.scaffold branch February 26, 2026 03:11

Conversation

wei-liu-sf commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Dependencies

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yhsieh1 Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yhsieh1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patricksullivansf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wei-liu-sf commented Feb 24, 2026 •

edited

Loading

yhsieh1 Feb 25, 2026 •

edited

Loading

yhsieh1 left a comment •

edited

Loading