hello-mcp-server
An interactive tutorial MCP server that teaches Model Context Protocol through extensively commented code, interactive testing, and hands-on exercises, enabling developers to learn MCP by building and modifying real-world examples.
README
Hello MCP Server - Learn MCP by Example
The best way to learn Model Context Protocol (MCP) through hands-on exploration. This isn't just a working MCP serverโit's an interactive tutorial that teaches you MCP concepts through extensively commented, real-world code.
๐ Why This Repository Exists
Learning MCP can feel overwhelming with abstract concepts and scattered documentation. This repository takes a different approach:
- Learn by Reading: Every line of code is extensively commented to explain both what it does and why
- Learn by Testing: Use MCP Inspector to interact with real tools, resources, and prompts
- Learn by Modifying: Start with working examples, then experiment and build your own features
- Learn by Building: Understand the complete MCP server architecture from setup to deployment
Perfect for developers who learn best through practical examples rather than theoretical documentation.
๐ Learning Path: Start Here!
๐ Step 1: Core MCP Understanding
Begin with src/index.ts - This is your learning goldmine! The file includes:
- Clear explanations of what MCP is and why it matters
- The three core MCP primitives: Tools, Resources, and Prompts
- How Claude communicates with MCP servers
- Working examples of each concept with detailed comments
- Real request/response patterns you can test
Then read README.md (this file) for the big picture and practical usage.
๐ง Step 2: Project Configuration
Study TSCONFIG_EXPLAINED.md - Learn why each TypeScript setting matters for MCP development, explained in beginner-friendly terms.
Review package.json - Understand the essential MCP dependencies and build process.
๐งช Step 3: Hands-On Experimentation
- Set up and test (see Installation section below)
- Use MCP Inspector to interact with the server
- Modify the code - change greetings, add parameters, create new tools
- Build your own features using the patterns you've learned
๐ก What You'll Learn
This repository demonstrates all essential MCP concepts:
Tools - Functions Claude Can Call
// Example: A greeting tool that accepts parameters and returns results
{
name: "say_hello",
description: "Says hello to the specified person",
inputSchema: {
type: "object",
properties: {
name: { type: "string", description: "The name to greet" }
}
}
}
Resources - Data Claude Can Read
// Example: Server information that updates in real-time
{
uri: "mcp://server-info",
name: "Server Information",
description: "Current server status and statistics"
}
Prompts - Templates That Guide Claude
// Example: Customizable greeting templates
{
name: "greeting-generator",
description: "Generate greetings based on tone and context",
arguments: [
{ name: "tone", description: "formal, casual, friendly" },
{ name: "context", description: "meeting, email, introduction" }
]
}
๐ ๏ธ Installation & Setup
Prerequisites
- Node.js 18.0 or later
- npm or yarn package manager
- Basic TypeScript knowledge (helpful but not required)
Quick Start
# Clone and setup
git clone https://github.com/YOUR_USERNAME/hello-mcp-server.git
cd hello-mcp-server
npm install
# Build the project
npm run build
# Test with MCP Inspector
npx @modelcontextprotocol/inspector node build/index.js
Development Mode
# Auto-rebuild on changes
npm run dev
# Run the compiled server
npm start
๐งช Interactive Testing with MCP Inspector
MCP Inspector is your best friend for learning. It provides a web interface to test your server:
-
Launch Inspector:
npx @modelcontextprotocol/inspector node build/index.js -
Test Each Primitive:
- Tools: Try the
say_hellotool with different names - Resources: Read the
server-inforesource to see live data - Prompts: Use
greeting-generatorwith various tones and contexts
- Tools: Try the
-
Watch the Communication: See the actual JSON-RPC messages between Claude and your server
๐ Detailed API Reference
Tools
say_hello
Demonstrates basic tool implementation with parameter validation and response formatting.
Input Schema:
{
"name": "string" // Required - The name of the person to greet
}
Example Usage:
{
"name": "Alice"
}
Response:
{
"content": [
{
"type": "text",
"text": "Hello, Alice! Welcome to my MCP server!"
}
]
}
Resources
server-info (mcp://server-info)
Demonstrates dynamic resource generation with real-time data.
Response: Plain text with server statistics, uptime, system info, and capabilities.
Prompts
greeting-generator
Shows how to create flexible prompt templates with parameters.
Arguments:
tone(required): The tone of the greeting (formal, casual, friendly, etc.)context(required): The context where the greeting will be used (meeting, email, etc.)
๐ฏ Learning Exercises
Beginner Exercises
- Modify the greeting: Change the
say_helloresponse message - Add a parameter: Add an optional
languageparameter tosay_hello - Create a simple tool: Build a
get_timetool that returns the current time
Intermediate Exercises
- Add a new resource: Create a
system-statsresource with memory and CPU info - Build a calculation tool: Create a
calculatortool with basic math operations - Extend the prompt: Add more parameters to
greeting-generator
Advanced Exercises
- File system integration: Create tools that can read/write files safely
- API integration: Build tools that call external APIs
- State management: Create tools that maintain state between calls
๐ Project Structure
hello-mcp-server/
โโโ src/
โ โโโ index.ts # ๐ Main learning resource - extensively commented MCP implementation
โโโ build/ # โ๏ธ Compiled JavaScript output
โโโ TSCONFIG_EXPLAINED.md # ๐ TypeScript configuration tutorial
โโโ GITHUB_SETUP.md # ๐ Publishing guide
โโโ CONTRIBUTING.md # ๐ค Contribution guidelines
โโโ package.json # ๐ฆ Dependencies and scripts (with educational comments)
โโโ tsconfig.json # โ๏ธ TypeScript configuration
โโโ README.md # ๐ This learning guide
๐ Educational Philosophy
This project follows the principle that the best way to learn is through working examples:
- Comments Explain Context: Not just what the code does, but why MCP works this way
- Progressive Complexity: Start simple, then explore advanced patterns
- Real-World Patterns: Learn practices you'll actually use in production
- Interactive Learning: Test and modify rather than just read
๐ค Contributing to Learning
Help make this an even better learning resource:
- Improve Comments: Make explanations clearer for beginners
- Add Examples: Contribute new tools, resources, or prompts with educational value
- Share Use Cases: Document how you've extended this for real projects
- Fix Issues: Help other learners by improving error messages and documentation
See CONTRIBUTING.md for guidelines.
๐ฎ Next Steps After Learning
Once you understand the patterns:
- Build Real Tools: Create MCP servers for your specific use cases
- Explore the Ecosystem: Check out other MCP servers and tools
- Join the Community: Share your creations and learn from others
- Contribute Back: Help improve MCP documentation and tooling
๐ Success Stories
Have you used this repository to learn MCP? Share your story by opening an issue or discussion!
๐ Learning Support
- Questions: GitHub Discussions
- Issues: GitHub Issues
- MCP Documentation: modelcontextprotocol.io
- Community: Join the MCP community for broader discussions
๐ License
MIT License - See LICENSE file for details.
๐ Acknowledgments
- Model Context Protocol team for creating an amazing standard
- The TypeScript and Node.js communities for excellent tooling
- Everyone who contributes to making MCP more accessible through education
Ready to learn MCP? Start with src/index.ts and let the commented code be your guide! ๐
Recommended Servers
playwright-mcp
A Model Context Protocol server that enables LLMs to interact with web pages through structured accessibility snapshots without requiring vision models or screenshots.
Magic Component Platform (MCP)
An AI-powered tool that generates modern UI components from natural language descriptions, integrating with popular IDEs to streamline UI development workflow.
Audiense Insights MCP Server
Enables interaction with Audiense Insights accounts via the Model Context Protocol, facilitating the extraction and analysis of marketing insights and audience data including demographics, behavior, and influencer engagement.
VeyraX MCP
Single MCP tool to connect all your favorite tools: Gmail, Calendar and 40 more.
graphlit-mcp-server
The Model Context Protocol (MCP) Server enables integration between MCP clients and the Graphlit service. Ingest anything from Slack to Gmail to podcast feeds, in addition to web crawling, into a Graphlit project - and then retrieve relevant contents from the MCP client.
Kagi MCP Server
An MCP server that integrates Kagi search capabilities with Claude AI, enabling Claude to perform real-time web searches when answering questions that require up-to-date information.
E2B
Using MCP to run code via e2b.
Neon Database
MCP server for interacting with Neon Management API and databases
Exa Search
A Model Context Protocol (MCP) server lets AI assistants like Claude use the Exa AI Search API for web searches. This setup allows AI models to get real-time web information in a safe and controlled way.
Qdrant Server
This repository is an example of how to create a MCP server for Qdrant, a vector search engine.