项目简介

这是一个命令行工具(CLI),旨在帮助开发者快速搭建和部署 Model Context Protocol (MCP) 服务器到 Cloudflare Workers。它提供了一个基础模板,并通过简单的函数定义和 JSDoc 注释即可创建 LLM 可调用的工具,极大简化了 MCP 服务器的开发和部署流程。

主要功能点

  • 自动化创建: 通过一个命令即可生成一个功能完备的基础 MCP 服务器项目结构。
  • Cloudflare Workers 集成: 自动配置并部署 MCP 服务器到 Cloudflare Workers,利用其便捷的部署和运行环境。
  • 简化工具开发: 开发者只需在 TypeScript 类中编写普通函数,并使用 JSDoc 添加描述和参数信息,即可自动转化为 MCP 工具。
  • 现有服务器克隆: 支持克隆其他使用此工具或兼容结构的 MCP 服务器仓库进行快速启动和修改。
  • 客户端配置生成: 部署完成后,自动生成并复制适用于 MCP 客户端(如 Cursor)的服务器连接命令。

安装步骤

  1. 确保您已安装 Bun(推荐)、npm、yarn 或 pnpm 中的任意一个包管理器。

  2. 安装并登录 Cloudflare Wrangler CLI

  3. 运行以下命令创建新的 MCP 服务器项目:

    bun create mcp <您的项目名称>

    (您也可以不指定名称,CLI 会在后续提示您输入。) 如果想克隆现有项目,使用:

    bun create mcp <您的项目名称> --clone <GitHub 仓库 URL>
  4. CLI 会引导您完成项目名称、包管理器选择等设置,并自动执行项目初始化、依赖安装、Git 初始化以及初次部署到 Cloudflare Workers 的过程。

服务器配置

MCP 客户端连接 MCP 服务器需要配置服务器的启动信息,通常包括服务器名称、启动命令 (command) 和参数 (args)。使用 'create-mcp' 工具部署完成后,它会自动为您生成并复制所需的启动命令。

您需要在 MCP 客户端(例如 Cursor 的 MCP Servers 设置中)添加一个新的 MCP 服务器配置,该配置通常包含以下信息:

  • 'name': 服务器的唯一名称(即您创建项目时指定的名称)。
  • 'command': 启动 MCP 服务器进程的可执行文件路径(通常是 'workers-mcp' 所在的路径,由工具自动找到)。
  • 'args': 传递给启动命令的参数列表。对于由 'create-mcp' 创建的服务器,这些参数通常包括 'run' 指令、服务器名称、Cloudflare Workers 的 URL 以及项目本地文件路径,用于建立本地开发环境与远程 Workers 之间的连接。

工具生成的复制到剪贴板的字符串即是组合了 'command' 和 'args' 的完整启动命令行。您只需将这些信息正确填入 MCP 客户端的配置界面即可。

基本使用方法

  1. 添加新工具: 打开项目中 'src/index.ts' 文件,在 'MyWorker' 类中添加新的异步函数。使用 JSDoc 注释来定义函数的描述、参数('@param {类型} 参数名 参数描述')和返回值('@return {类型} 返回值描述')。这些注释将用于向 LLM 客户端说明工具的功能和用法。

  2. 部署更改: 在项目根目录下运行部署命令:

    bun run deploy

    (或其他包管理器的等效命令)

  3. 在客户端使用: 部署成功后,在您的 LLM 客户端(如 Cursor)中重新加载或刷新,您的新工具即可被 AI Agent 识别和调用。

信息

分类

开发者工具