使用说明
FastMCP沸腾板
一个样板 FastMCP.
这个样板是构建MCP服务器的一个很好的起点。它包括测试、linting、格式化和发布到NPM的基本设置。
发展
首先，克隆存储库并安装依赖项。
git clone https://github.com/punkpeye/fastmcp-boilerplate.git
cd fastmcp-boilerplate
npm install
npm run dev
[！注意] 如果你正在开始一个新项目，你可能想分叉 fastmcp样板 然后从那里开始。
启动服务器
如果你只是想启动服务器，你可以使用 start 脚本。
npm run start
但是，您也可以使用 dev 脚本。
npm run dev
这将启动服务器，并允许您使用CLI与之交互。
测试
一个好的MCP服务器应该有测试。但是，您不需要测试MCP服务器本身，而是需要测试您实现的工具。
npm run test
在这种样板的情况下，我们只测试 add 工具。
代码检查
拥有一个良好的linting设置可以减少其他开发人员为您的项目做出贡献的摩擦。
npm run lint
此样板使用 更漂亮, ESLint 和 TypeScript ESLint 以破解代码。
格式化
使用 npm run format 以格式化代码。
npm run format
GitHub操作
此存储库有一个GitHub Actions工作流，该工作流使用以下命令运行linting、格式化、测试并将包更新发布到NPM 语义释放.
要使用此工作流，您需要：
- 添加
NPM_TOKEN到存储库机密- 创建新的自动化令牌
- 添加令牌为
NPM_TOKEN环境机密（设置→ 秘密和变量→ 行动→ “管理环境机密”→ “释放”→ 添加环境机密）
- 授予工作流的写入权限（设置→ 行动→ 将军→ 工作流权限→ “读写权限”）
