FastMCP Boilerplate

FastMCP Boilerplate

site icon
2025.05.09 3
TypeScriptMCP服务器模板开发工具链开发效率
FastMCP Boilerplate 是一个用于构建 MCP 服务器的模板项目。它提供了基本的开发环境设置,包括测试、代码检查、格式化以及发布到 NPM 的功能。该项目适合作为新 MCP 服务器项目的起点。
View on GitHub

Overview

基本能力

产品定位

FastMCP Boilerplate 是一个用于快速构建 MCP 服务器的模板项目,旨在提供开发、测试、代码检查和发布的完整工具链。

核心功能

  • 提供基本的 MCP 服务器开发环境
  • 支持测试、代码检查(Linting)和代码格式化
  • 集成 GitHub Actions 实现自动化发布
  • 提供 CLI 交互功能

适用场景

  • 开发新的 MCP 服务器项目
  • 需要标准化开发流程的 MCP 项目
  • 需要自动化测试和发布的 MCP 项目

工具列表

  1. 测试工具:通过 npm run test 运行测试
  2. 代码检查工具:使用 Prettier、ESLint 和 TypeScript ESLint 进行代码检查(npm run lint
  3. 代码格式化工具:通过 npm run format 格式化代码
  4. 自动化发布工具:使用 semantic-release 实现自动化发布

常见问题解答

  1. 如何开始新项目:建议 fork 此模板项目作为起点
  2. 如何设置自动化发布:需要添加 NPM_TOKEN 到仓库 secrets 并设置工作流权限

使用教程

使用依赖

  1. 需要安装 Node.js 和 npm
  2. 需要 Git 进行版本控制

安装教程

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

启动服务器

npm run dev  # 开发模式,支持 CLI 交互
npm run start  # 生产模式

调试方式

npm run test  # 运行测试
npm run lint  # 检查代码质量
npm run format  # 格式化代码

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。