Hello World MCP Server

🚀 Hello, World MCP Server

This project demonstrates how to set up a server using the Model Context Protocol (MCP) SDK. It includes tools, prompts, and endpoints for handling Server-Side Events (SSE) and messages.

This project is part of the blog post: Building a TypeScript MCP Server: A Guide for Integrating Existing Services. Visit the blog to understand the concepts and implementation details behind the project.

✨ Features

• MCP Integration: Create a server with tools and prompts using the MCP SDK.
• Express Framework: Handle HTTP endpoints for SSE and message communication.
• Environment Configuration: Use the .env file for simple configuration.
• TypeScript Support: A fully typed codebase to enhance the developer experience.

📦 Installation

Prerequisites

Before you start, make sure you have the following installed:

1. Node.js (v16 or higher) - Download here
2. npm (comes with Node.js) or yarn

Steps

Follow these steps to set up and run the project:

1. Clone the repository If you haven't already, clone the repository to your local machine:

   git clone https://github.com/your-username/hello-world-mcp-server.git
   cd hello-world-mcp-server
   

2. Install dependencies Install the required dependencies using npm or yarn:

   npm install
   

   or

   yarn install
   

3. Configure environment variables The project uses the .env file to configure the server port. An example .env.example file is provided.
   • Copy .env.example to .env:

   cp .env.example .env
   

   • Open the .env file and update the PORT variable if needed. The default is 4000.

   PORT=4000
   

4. Build the project Compile the TypeScript code to JavaScript:

   npm run build
   

   This will generate the compiled files in the dist directory.
5. Run the server Run the server in production mode:

   npm start
   

   Alternatively, use the development mode (with live reloading):

   npm run dev
   

💻 Usage Examples

Testing the Server

Using the MCP Inspector

The MCP Inspector is a tool to test and inspect your MCP server. You can use it to verify that the registered tools and prompts are correct. Run the following command to check your server:

npx @modelcontextprotocol/inspector ./dist/server.js

This will open an interactive interface where you can test the tools and prompts registered in the server.

📚 Documentation

Project Structure

Here is an overview of the project structure:

hello-world-mcp-server/
├── src/
│   ├── server.ts                     # Main server file
│   ├── index.ts                      # Entry point
│   └── routes/
│       └── exampleRoute.ts          # Example route
├── .env                             # Environment variable configuration
├── package.json                    # Project dependencies and scripts
├── tsconfig.json                   # TypeScript configuration
└── README.md                       # Project documentation

🤝 Contribution

Contributions are welcome! Feel free to open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License. For more details, see the LICENSE file.