ModelContextProtocol SDK 在 CommonJS 项目中的兼容性问题分析与解决方案

问题背景

ModelContextProtocol 是一个用于构建和管理 AI 模型的协议框架，其 TypeScript SDK 为开发者提供了便捷的接入方式。然而，近期有开发者反馈在 CommonJS 项目（如 NestJS）中使用该 SDK 时遇到了兼容性问题。

问题现象

当开发者在 CommonJS 环境中使用 ModelContextProtocol SDK 时，会触发以下运行时错误：

Error [ERR_REQUIRE_ESM]: require() of ES Module `pkce-challenge` is not supported in CommonJS modules. Use dynamic `import()` instead.

这个错误表明 SDK 在尝试使用 CommonJS 的 require() 语法导入一个仅支持 ESM 的模块 pkce-challenge，这在 Node.js 的模块系统中是不被允许的。

技术分析

模块系统差异

Node.js 支持两种模块系统：

1. CommonJS (CJS)：使用 require() 和 module.exports
2. ECMAScript Modules (ESM)：使用 import/export 语法

pkce-challenge 是一个仅支持 ESM 的包，而 ModelContextProtocol SDK 在 CommonJS 构建产物中使用了传统的 require() 方式来导入它，导致了兼容性问题。

认证流程中的 PKCE

PKCE (Proof Key for Code Exchange) 是 OAuth 2.0 的一个扩展，用于增强公共客户端的授权安全性。ModelContextProtocol SDK 使用 pkce-challenge 包来生成 PKCE 所需的 code_verifier 和 code_challenge。

解决方案

临时解决方案

1. 版本回退：暂时回退到 1.5.0 版本，该版本尚未引入 pkce-challenge 依赖
2. 手动补丁：使用 patch-package 工具修改 SDK 的构建产物

推荐解决方案

开发者可以修改 SDK 的认证模块，使用动态 import() 替代 require()。以下是核心修改点：

// 修改前
const pkce_challenge_1 = __importDefault(require("pkce-challenge"));

// 修改后
let pkce_challenge_1 = { default: null };

async function loadPkceChallenge() {
  if (!pkce_challenge_1.default) {
    const mod = await import("pkce-challenge");
    pkce_challenge_1.default = mod.default;
  }
}

长期建议

对于 SDK 维护者，建议：

1. 在构建配置中明确区分 ESM 和 CommonJS 输出
2. 对于依赖的 ESM-only 包，使用动态导入或提供替代方案
3. 在文档中明确说明模块系统兼容性

总结

ModelContextProtocol SDK 在 CommonJS 环境中的兼容性问题源于现代 JavaScript 生态中模块系统的过渡期。开发者可以通过上述解决方案临时解决问题，但长期来看，需要 SDK 维护者对模块系统兼容性进行更全面的考虑和处理。

对于使用 NestJS 等基于 CommonJS 框架的开发者，理解模块系统差异并掌握动态导入技术，将有助于解决类似的前沿技术兼容性问题。