FastMCP 模板项目

这是一个用于 FastMCP 的模板项目。

此模板是一个很好的起点，用于构建一个 MCP 服务器。它包括了测试、代码检查、代码格式化以及发布到 NPM 的基本设置。

开发

要开始，请克隆仓库并安装依赖项。

git clone https://github.com/punkpeye/fastmcp-boilerplate.git
cd fastmcp-boilerplate
npm install
npm run dev

[!NOTE] 如果您正在启动一个新的项目，可能需要 fork 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。

为了使用此工作流，您需要：

1. 在仓库的秘密中添加 NPM_TOKEN
   1. 创建一个新的自动化令牌
   2. 将令牌作为 NPM_TOKEN 环境秘密添加（设置 → 秘密和变量 → 动作 → “管理环境秘密” → “release” → 添加环境秘密）
2. 授予工作流写入权限（设置 → 动作 → 通用 → 工作流权限 → “读取和写入权限”）