Stellaris Modding MCP Server

🚀 FastMCP Boilerplate

このBoilerplateは、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 スクリプトを使用することで、サーバーとCLIで対話することもできます。

npm run dev

これにより、サーバーが起動し、CLIを使ってサーバーと対話できるようになります。

テスト

良いMCPサーバーにはテストが必要です。ただし、MCPサーバー自体をテストするのではなく、実装したツールをテストする必要があります。

npm run test

このBoilerplateの場合、add ツールの実装のみをテストしています。

リント

適切なリント設定を行うことで、他の開発者がプロジェクトに貢献する際の摩擦を減らすことができます。

npm run lint

このBoilerplateでは、Prettier、ESLint、TypeScript ESLint を使用してコードをリントしています。

コードフォーマット

npm run format を使用してコードをフォーマットします。

npm run format

GitHub Actions

このリポジトリには、リント、コードフォーマット、テストを実行し、semantic-release を使用してNPMへのパッケージ更新を公開するGitHub Actionsワークフローがあります。

このワークフローを使用するには、以下の手順が必要です。

1. NPM_TOKEN をリポジトリのシークレットに追加します。
   1. 新しい自動化トークンを作成 します。
   2. トークンを NPM_TOKEN 環境シークレットとして追加します（Settings → Secrets and Variables → Actions → "Manage environment secrets" → "release" → Add environment secret）。
2. ワークフローに書き込みアクセス権を付与します（Settings → Actions → General → Workflow permissions → "Read and write permissions"）。