Stellaris Modding MCP Server

🚀 FastMCP 模板项目

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。 若要使用此工作流，你需要完成以下操作：

1. 向仓库的机密信息中添加 NPM_TOKEN：
   1. 创建一个新的自动化令牌
   2. 将令牌作为 NPM_TOKEN 环境机密信息添加（设置 → 机密信息和变量 → 操作 → “管理环境机密信息” → “发布” → 添加环境机密信息）
2. 授予工作流写入权限（设置 → 操作 → 常规 → 工作流权限 → “读取和写入权限”）