Hello World MCP Server
A simple Model Context Protocol (MCP) server that provides a hello world tool. This server serves as a boilerplate template to help developers quickly create and deploy new MCP servers. It demonstrates basic MCP server functionality with a greeting tool and can be easily modified to add custom tools and resources.
Features
Hello World Tool: Simple greeting tool that says "Hello, {name}" with default "world"
Input Validation: Uses Zod schemas for robust parameter validation
Simple and Clean: Minimal MCP server implementation for demonstration purposes
Using as a Boilerplate
This project serves as a starting template for building your own MCP servers. To create a custom MCP server:
Clone or fork this repository
Modify
index.js
to add your own tools usingserver.registerTool()
Update
package.json
with your server name and descriptionCustomize the README and configuration files as needed
The basic structure includes proper error handling, input validation with Zod, and MCP protocol compliance.
Hello World Tool
The server provides a simple hello world tool that greets users with a customizable name.
Tool Usage
The helloWorld
tool accepts an optional name
parameter and returns a greeting message.
Parameters:
name
: Name to greet (optional, defaults to "world")
Example Response:
Installation
Global Installation (Recommended)
Install globally via npm:
npm install -g hello-world-mcpThe
hello-world-mcp
command will be available system-wide
Local Installation
Clone or download this repository
Install dependencies:
npm installStart the server:
npm start
Usage
Starting the Server
MCP Configuration
For Global Installation
Add this to your MCP client configuration:
For Local Installation
Add this to your MCP client configuration:
Usage Examples
Hello World Tool
Response:
Default Greeting
Response:
Available Tools
Hello World Tool
helloWorld
A simple greeting tool that says "Hello, {name}" with default "world".
Parameters:
name
: Name to greet (optional, defaults to "world")
Hello World Examples
Basic Greeting
Response:
Default Greeting
Response:
Response Format
The hello world tool returns a simple text response:
Dependencies
@modelcontextprotocol/sdk
: MCP SDK for server implementationzod
: Schema validation library
License
ISC
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
A simple boilerplate MCP server that provides a basic greeting tool for demonstration purposes. Serves as a starting template for developers to quickly create and deploy custom MCP servers.