README Documentation
HelloWorld MCP Server
A simple HelloWorld MCP (Model Context Protocol) server experiment built with TypeScript.
Features
This MCP server provides two simple tools:
- hello: Say hello to someone (default: "World")
- add: Add two numbers together
Prerequisites
- Node.js 22+ (LTS)
- npm
- nvm (recommended for Node.js version management)
- direnv (for environment management)
Setup
-
Node.js Version Management
# If you have nvm installed: nvm use # This will use Node.js version 22 as specified in .nvmrc -
Environment Setup with direnv
# Allow direnv for this directory direnv allow # This will automatically add node_modules/.bin to your PATH -
Install Dependencies
npm install
Development
Available Scripts
npm run dev- Run the server in development mode using tsxnpm run build- Compile TypeScript to JavaScriptnpm start- Run the compiled servernpm run lint- Run ESLint on the source codenpm run lint:fix- Run ESLint and automatically fix issuesnpm run clean- Remove the dist directory
Running the Server
For development:
npm run dev
For production:
npm run build
npm start
MCP Server Usage
This server communicates via stdio and implements the Model Context Protocol. It provides:
Tools
-
hello
- Description: Say hello to someone
- Parameters:
name(optional): The name of the person to greet (default: "World")
- Example:
{"name": "Alice"}ā "Hello, Alice! š Welcome to the HelloWorld MCP server!"
-
add
- Description: Add two numbers together
- Parameters:
a(required): First numberb(required): Second number
- Example:
{"a": 5, "b": 3}ā "5 + 3 = 8"
Project Structure
āāā src/
ā āāā index.ts # Main MCP server implementation
āāā dist/ # Compiled JavaScript (after build)
āāā .nvmrc # Node.js version specification
āāā .envrc # direnv configuration
āāā eslint.config.js # ESLint configuration
āāā tsconfig.json # TypeScript configuration
āāā package.json # Node.js project configuration
āāā README.md # This file
Code Quality
This project uses:
- TypeScript for type safety
- ESLint with TypeScript support for code quality
- Strict TypeScript configuration for better type checking
License
MIT
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source