mcpField
C
create-mcp-ts

create-mcp-ts

本地服务
npmjs.com开发工具2179 周前更新

关于 create-mcp-ts

create-mcp-ts 是一个用于快速创建 TypeScript MCP 服务的脚手架工具,面向 MCP 服务开发者。它无需额外构建配置,并可自动将新服务写入 Cursor、Windsurf 和 Claude Desktop 的配置文件。

主要功能

  1. 01零构建配置的 TypeScript 项目生成
  2. 02基于 mcp-scripts 的开发与构建流程
  3. 03自动写入 Cursor、Windsurf、Claude Desktop 配置
  4. 04支持自定义项目模板
  5. 05提供 eject 命令移除内置构建工具

适用场景

  1. 01快速搭建新的 TypeScript MCP 服务
  2. 02将本地开发的 MCP 服务接入桌面客户端
  3. 03基于自定义模板统一团队的项目结构

MCP 相关

该工具生成的是 MCP 服务项目,并会在 Cursor、Windsurf 和 Claude Desktop 的 MCP 配置中添加服务条目。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"create-mcp-ts": {
"command": "npx",
"args": [
"-y",
"create-mcp-ts"
]
}
}
}
启动命令npx -y create-mcp-ts

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npmcreate-mcp-ts

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。

详细介绍

create-mcp-ts NPM 版本

使用 TypeScript 创建一个开箱即用的 MCP 服务。

开始使用

npm init mcp-ts your-server
cd your-server
npm run dev

create-mcp-ts 无需任何构建配置,会自动安装开发、构建和设置 MCP 服务所需的一切。

在 Cursor、Windsurf 和 Claude Desktop 中设置 MCP 服务

create-mcp-ts 可以自动在 Cursor、Windsurf 和 Claude Desktop 中配置 MCP 服务:

npm run setup

此脚本会检查每个客户端各自的 MCP 配置文件中是否已存在 your-server。如果不存在,就会添加一个指向服务脚本(dist/index.js)的条目:

{
  "mcpConfig": {
    "your-server": {
      "command": "node",
      "args": ["/path/to/your-server/dist/index.js"]
    }
  }
}

有关如何在 Cursor、Windsurf 和 Claude Desktop 中设置 MCP 服务的详细信息,请参阅:

自定义模板

如果想使用自定义模板,可以将模板的 npm 包名称或文件路径传递给 npx create-mcp-ts 命令:

npx create-mcp-ts your-server --template=mcp-ts-template-default
npx create-mcp-ts your-server --template=file:/path/to/mcp-ts-template
发布 MCP 服务

如果计划分享 MCP 服务,可以将其发布到 npm:

  1. 在 package.json 中设置 "version",并确保 "private" 设置为 false。
  2. 运行 npm install。
  3. 运行 npm run build。
  4. 运行 npm login(如有需要)。
  5. 运行 npm publish。

迁出 mcp-scripts

mcp-scripts 包包含用于 create-mcp-ts 项目的构建工具,提供开发、构建和设置 MCP 服务所需的一切,无需任何额外配置。

在底层,mcp-scripts 使用 tsup 和 esbuild,这两款轻量、经受过实战检验的工具非常适合用于生产级 TypeScript 项目。

如果想迁出 mcp-scripts,请运行以下命令:

npm run eject

此操作会移除 mcp-scripts 依赖,并替换项目 package.json 文件中的相关命令。

MCP 服务故障排除

确认已安装 Node.js

如果 MCP 服务运行时遇到问题,首先应检查是否已全局安装 Node.js。运行以下命令即可检查:

node --version

如果尚未安装 Node.js,可以按照此处的说明进行安装。

与 Node.js 版本管理器搭配使用

某些 MCP 客户端环境可能无法访问完整的系统 PATH,这可能会导致使用 nodenv 或 nvm 等 Node.js 版本管理器时出现问题。在这种情况下,需要在 MCP 配置中指定 Node.js 二进制文件的完整路径:

{
  "mcpConfig": {
    "your-server": {
      "command": "/absolute/path/to/node",
      "args": ["/path/to/your-mcp-server/dist/index.js"]
    }
  }
}

要查找 Node.js 二进制文件的绝对路径,可以运行:

which node

请务必在每个客户端(Cursor、Windsurf 或 Claude Desktop)中更新 MCP 配置,填入要使用的 Node.js 二进制文件的正确绝对路径。

如遇到其他问题,请在此处提交问题。

理念

create-mcp-ts 旨在为 MCP 服务开发者提供开箱即用、“拿来就能用”的体验。

  • 开箱即用:只有一个构建依赖 mcp-scripts。它使用 tsup、esbuild 和其他优秀的开源项目,并在此基础上提供精心整合的体验。
  • 零配置:无需配置任何内容。系统会为你处理合理的配置,让你专注于编写代码。
  • 无锁定:你随时可以“迁出”并改用自定义设置。只需运行一条命令,所有配置和构建依赖都会直接移入项目,让你可以从当前进度继续。

本项目的灵感来自 create-react-app。

相关软件包

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。