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. 授予工作流寫入權限（設置 → 操作 → 常規 → 工作流權限 → “讀取和寫入權限”）