EVE Online OSINT MCP

🚀 FastMCP Boilerplate

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

🚀 Quick Start

To begin, 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.

Start the server

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

npm run start

However, you can also interact with the server using the dev script.

npm run dev

This will start the server and allow you to interact with it using CLI.

💻 Usage Examples

Basic Usage

# Start the server
npm run start

Advanced Usage

# Start the server and interact with it using CLI
npm run dev

Testing

# Run tests
npm run test

A good MCP server should have tests. However, you don't need to test the MCP server itself, but rather the tools you implement. In the case of this boilerplate, we only test the implementation of the add tool.

Linting

# Run linting
npm run lint

Having a good linting setup reduces the friction for other developers to contribute to your project. This boilerplate uses Prettier, ESLint and TypeScript ESLint to lint the code.

Formatting

# Format the code
npm run format

🔧 Technical Details

GitHub Actions

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

In order to use this workflow, you need to:

1. Add NPM_TOKEN to the repository secrets
   1. Create a new automation token
   2. Add token as 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")