Feature/dual module support

[zkabyken]

Description

Adds CommonJS build support alongside existing ES module support, enabling the library to work in both CommonJS and ES module environments while maintaining full backward compatibility. This enhancement allows the library to be used in a wider range of Node.js environments and build systems

The changes include:

• Added "require" export and updated "main" entry point in package.json
• Added build:cjs and build:all scripts for CommonJS compilation
• Created tsconfig.cjs.json for CommonJS TypeScript configuration
• Added dist-cjs/package.json with "type": "commonjs" for proper module resolution
• Moved index.ts to src/index.ts for better code organization

Big fan of the project and would love to see it succeed! The dual module support will make the library more accessible to different development environments and build systems.

Type of change

• New feature (non-breaking change which adds functionality)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have added tests that prove my fix is effective or that my feature works
• The title of my pull request follows the conventional commits standard
• Changes have been documented in the README/documentation (if applicable)

[zkabyken]

@Pederzh @pietrozullo Would appreciate it if you could take a look when you have a moment. Let me know if there's anything you'd like me to change or improve!

[Copilot]

Pull Request Overview

Adds support for CommonJS builds while retaining existing ES module output and reorganizes the project root.

• Introduces a new tsconfig.cjs.json for CJS compilation into dist-cjs
• Updates package.json to wire up "require" exports, switch main to CJS, and add build scripts
• Moves the primary entry file into src/ and removes the old root index.ts

Reviewed Changes

Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.

File	Description
tsconfig.cjs.json	Add CJS compiler config targeting dist-cjs
src/index.ts	New consolidated entry point exporting all public APIs
package.json	Update exports, main, add CJS build scripts and files
index.ts	Remove root entry file in favor of src/index.ts

Comments suppressed due to low confidence (2)

tsconfig.cjs.json:10

• The CJS tsconfig still includes a top-level "index.ts" which has been removed. This will prevent the compiler from picking up src/index.ts. Update the include to refer to src/index.ts or remove the root index.ts entry.

  "include": ["index.ts", "src/**/*.ts"],

package.json:86

• [nitpick] The lodash dependency appears unused in the new code paths. If you’re not importing it anywhere, removing it will reduce package bloat.

    "lodash": "^4.17.21",

[Copilot]

[nitpick] The build:cjs script uses Unix-only commands (rm, shell redirection) which may break on Windows. Consider using a cross-platform tool like rimraf or a Node-based script to ensure compatibility.

[Pederzh]

@zkabyken, can you also have a look at this please?

[zkabyken]

Thanks @Pederzh! Added a script to support cross-platform CommonJS build support using shx that is then executed from package.json. Also made sure to resolve merge conflicts and double checked npm build runs (:cjs and :all)

[zkabyken]

Thanks for the discord link! mcp-use is brilliant and I see it being very widely used soon!

[Pederzh]

Adds CommonJS build support alongside existing ES module support, enabling the library to work in both CommonJS and ES module environments while maintaining full backward compatibility. This enhancement allows the library to be used in a wider range of Node.js environments and build systems

The changes include:

• Added "require" export and updated "main" entry point in package.json
• Added build:cjs and build:all scripts for CommonJS compilation
• Created tsconfig.cjs.json for CommonJS TypeScript configuration
• Added dist-cjs/package.json with "type": "commonjs" for proper module resolution
• Moved index.ts to src/index.ts for better code organization

Big fan of the project and would love to see it succeed! The dual module support will make the library more accessible to different development environments and build systems.

Hi @zkabyken we're glad that you are a fan of the project, thanks for your support :)

Thanks for taking the time to create this PR!
I've made some changes to the library.
Can you please resolve the merge conflicts?

We'd love to have you join our Discord community to chat about how you're planning to use mcp-use!
https://discord.gg/XkNkSkMz3V

[zkabyken]

Hi @Pederzh, I’ve addressed all the comments, this PR should be fully ready now. Let me know if there’s anything else you’d like me to tweak. Super excited to see it get merged!

[zkabyken]

Hi @pietrozullo! Wondering if you could take a look at this PR whenever possible, would love to continue contributing after this is merged!

[RefaelEX]

Hi, I really love this project and find it very good and useful.
and I also need this dual module support, is this pr going to be merged?

Thanks in advanced.

[Pederzh]

Hi, I really love this project and find it very good and useful. and I also need this dual module support, is this pr going to be merged?

Thanks in advanced.

Hello guys @zkabyken and @RefaelEX , this PR has been stale for a while because it doesn't provide any tests for the changes, and also certifies the double support.

I'd like to invite you to create some tests and update them by merging the latest version into this branch, and then create additional tests to verify that the library will continue to function properly.

PS I've recently removed shx dependency for cross-platform commands and it should be brought back.