🚀 FastMCP 模板
这是一个为 FastMCP 准备的模板。该模板是搭建 MCP 服务器的理想起点，它包含了用于测试、代码检查、格式化以及发布到 NPM 的基础配置。
🚀 快速开始
要开始使用，首先克隆仓库并安装依赖项。
git clone https://github.com/punkpeye/fastmcp-boilerplate.git
cd fastmcp-boilerplate
npm install
npm run dev
⚠️ 重要提示
如果你要启动一个新项目，你可以从 fastmcp-boilerplate 创建一个分支并在此基础上开始开发。
启动服务器
如果你只是想启动服务器，可以使用 start 脚本。
npm run start
不过，你也可以使用 dev 脚本与服务器进行交互。
npm run dev
这将启动服务器，并允许你通过命令行界面与它进行交互。
测试
一个优秀的 MCP 服务器应该有测试。不过，你不需要测试 MCP 服务器本身，而是要测试你实现的工具。
npm run test
在这个模板中，我们只测试 add 工具的实现。
代码检查
良好的代码检查配置可以减少其他开发者为你的项目做出贡献时的阻碍。
npm run lint
这个模板使用 Prettier、ESLint 和 TypeScript ESLint 来检查代码。
代码格式化
使用 npm run format 来格式化代码。
npm run format
GitHub Actions
这个仓库有一个 GitHub Actions 工作流，它会运行代码检查、格式化、测试，并使用 semantic-release 将包更新发布到 NPM。 为了使用这个工作流，你需要：
- 将
NPM_TOKEN添加到仓库的机密中- 创建一个新的自动化令牌
- 将令牌作为
NPM_TOKEN环境机密添加（设置 → 机密和变量 → 操作 → “管理环境机密” → “发布” → 添加环境机密）
- 授予工作流写入权限（设置 → 操作 → 常规 → 工作流权限 → “读取和写入权限”）