fastmcp-boilerplate

What is fastmcp-boilerplate?

A boilerplate project for building MCP servers using FastMCP, a TypeScript framework for the Model Context Protocol. It is intended for developers who want to quickly start creating MCP servers with a ready-to-use structure and example code.

How to use fastmcp-boilerplate?

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.

Key features of fastmcp-boilerplate

• 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

Use cases of fastmcp-boilerplate

• Quickly bootstrap a new MCP server project
• Learn FastMCP patterns and project layout
• Test and debug MCP tools with the Inspector
• Extend with custom resources, tools, or prompts

FAQ from fastmcp-boilerplate

What runtime is required?

Bun is required as the JavaScript runtime, package manager, and bundler. Install it from the official documentation.

How do I install dependencies and run the server?

Run bun install to install dependencies, then bun run index.ts to start the server.

How can I test or inspect the server?

Run bun test to execute the included tests, or bun run inspect to open the MCP Inspector in a web UI.

What is the project structure?

The main entry point is src/index.ts. There is an example module src/add.ts and a corresponding test file src/add.test.ts. Additional tools and resources can be added following this pattern.