Stellaris Modding MCP Server

🚀 FastMCP Boilerplate

A boilerplate for FastMCP, serving as an excellent starting point for building an MCP server. It encompasses a basic setup for testing, linting, formatting, and publishing to NPM.

🚀 Quick Start

To initiate the development process, clone the repository and install the dependencies:

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

⚠️ Important Note

If you are starting a new project, you may want to fork fastmcp-boilerplate and start from there.

💻 Starting the Server

If you simply want to start the server, you can use the start script:

npm run start

Alternatively, you can interact with the server using the dev script:

npm run dev

This will start the server and enable you to interact with it via the CLI.

🧪 Testing

A well - structured MCP server should have tests. However, you don't need to test the MCP server itself, but rather the tools you implement:

npm run test

In the case of this boilerplate, we only test the implementation of the add tool.

🧹 Linting

A good linting setup reduces the friction for other developers to contribute to your project:

npm run lint

This boilerplate uses Prettier, ESLint and TypeScript ESLint to lint the code.

🎨 Formatting

Use the following command to format the code:

npm run format

🤖 GitHub Actions

This repository has a GitHub Actions workflow that runs linting, formatting, tests, and publishes package updates to NPM using semantic-release.

To use this workflow, you need to:

1. Add NPM_TOKEN to the repository secrets:
   1. Create a new automation token
   2. Add the token as the NPM_TOKEN environment secret (Settings → Secrets and Variables → Actions → "Manage environment secrets" → "release" → Add environment secret)
2. Grant write access to the workflow (Settings → Actions → General → Workflow permissions → "Read and write permissions")