fastmcp-boilerplate

by kyrelldixon

356 downloads
Not rated
GitHub

About

A simple boilerplate for creating MCP servers with bun and fastmcp

Details

Author
kyrelldixon
Downloads
356
Categories
Developer Tools

- Based on the FastMCP TypeScript framework
- Uses Bun as runtime, package manager, and bundler
- Includes an example add module and test
- Supports MCP Inspector for debugging
- Minimal, easy-to-extend project structure

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name fastmcp-boilerplate
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install dependencies with bun install, then run the server with bun run index.ts. You can run tests with bun test or launch the MCP Inspector for a web UI using bun run inspect.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "fastmcp-boilerplate": {
            "fastmcp-boilerplate": {
                "command": "bun",
                "args": [
                    "run",
                    "index.ts"
                ]
            }
        }
    }
}

McpServers

{
    "fastmcp-boilerplate": {
        "command": "bun",
        "args": [
            "run",
            "index.ts"
        ]
    }
}

fastmcp-boilerplate

A boilerplate project for building MCP servers using FastMCP, a TypeScript framework for building Model Context Protocol (MCP) servers.

Prerequisites

This project uses Bun, a fast all-in-one JavaScript runtime, package manager, and bundler. You can install it following the official documentation.

Getting Started

To install dependencies:

bun install

To run the project:

bun run index.ts

To run tests:

bun test

Another way to run the server is to use the official MCP Inspector to inspect your server with a Web UI:

bun run inspect

Project Structure

- src/index.ts: Main entry point for the MCP server
- src/add.ts: Example module with an add function
- src/add.test.ts: Example test for the add function

About

This project is a boilerplate inspired by the fastmcp-boilerplate.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.