使用说明

项目简介

'create-mcp' 是一个命令行工具，旨在简化 MCP (Model Context Protocol) 服务器的创建和部署流程。它基于 Cloudflare Workers 平台，让开发者能够通过编写简单的 TypeScript 函数并添加 JSDoc 注释，快速构建可供 LLM 客户端（如 Cursor Agent）调用的工具。

主要功能点

快速搭建 MCP 服务器: 通过简单的命令行指令，即可生成一个基础的 MCP 服务器项目。
Cloudflare Workers 部署: 项目设计为部署在 Cloudflare Workers 上，利用其serverless特性，无需管理服务器，部署快速。
工具定义简洁: 通过编写 TypeScript 函数并使用 JSDoc 注释来定义 MCP 工具，降低了开发门槛。
自动配置: 工具链自动处理项目配置、依赖安装和部署流程，提升开发效率。
集成 Cursor Agent: 生成的 MCP 服务器可以直接与 Cursor Agent 集成，方便在 Cursor 编辑器中使用自定义工具。

安装步骤

安装 Wrangler CLI: 确保已安装 Cloudflare 的 Wrangler CLI 工具，并已登录 Cloudflare 账号。参考 Wrangler CLI 安装文档完成安装和登录。
安装 Claude Desktop App (根据 README 描述，未来可能会移除此依赖)。

运行 create-mcp 命令: 在终端中执行以下命令，创建新的 MCP 服务器项目：

bun create mcp

或者指定项目名称：

bun create mcp --name <server-name>

服务器配置

'create-mcp' 工具会自动处理服务器的配置和部署。在项目创建和部署完成后，工具会在终端输出 MCP 服务器的启动命令，并复制到剪贴板。您需要将此命令粘贴到 MCP 客户端（例如 Cursor）的服务器配置中，以建立连接。

以下是一个 MCP 客户端（如 Cursor）所需的服务器配置信息示例 (JSON 格式，请根据实际情况替换)：

{
  "serverName": "your-server-name",  //  服务器名称，可以自定义
  "command": "/path/to/workers-mcp", //  MCP 服务器执行命令的路径 (由 create-mcp 工具自动管理)
  "args": [
    "run",
    "your-server-name",       //  服务器项目名称 (由 create-mcp 工具自动管理)
    "your-worker-url",        //  Cloudflare Worker 的 URL，部署后获取 (由 create-mcp 工具自动管理)
    "/path/to/your/project/directory" // 服务器项目本地路径 (由 create-mcp 工具自动管理)
  ]
}

重要提示: 'create-mcp' 工具在部署成功后，会自动生成并复制正确的 'command' 和 'args' 到剪贴板。您只需将复制的内容粘贴到 MCP 客户端的服务器配置中即可，无需手动填写以上 JSON 配置信息。

基本使用方法

添加工具函数: 打开 'src/index.ts' 文件，在 'MyWorker' 类中添加新的 TypeScript 函数。使用 JSDoc 注释来描述工具的功能、参数和返回值。

/**
 * 工具描述：例如，获取指定数量的编程笑话。
 * @param n {number} 笑话的数量。
 * @return {Promise<any>} JokeAPI 的响应数据。
 */
async getJokes(n: number) {
    // 工具的具体实现代码
}

部署更改: 在项目根目录下运行以下命令，将修改后的代码部署到 Cloudflare Workers：
```
bun run deploy
```
在 Cursor 中使用: 重新加载 Cursor 编辑器窗口，即可在 Cursor Agent 中使用新添加的工具。

关键词