Hello World MCP Server

🚀 你好，世界MCP服务器

本项目演示了如何借助模型上下文协议（MCP） SDK搭建一个服务器。它集成了工具、提示功能，还包含处理服务器端事件（SSE）和消息的端点。

🚀 快速开始

克隆仓库

若你还未克隆仓库，可将其克隆到本地：

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

安装依赖项

使用 npm 或 yarn 安装所需依赖：

npm install

或

yarn install

配置环境变量

项目借助 .env 文件配置服务器端口，已提供示例文件 .env.example。

1. 复制 .env.example 到 .env：

cp .env.example .env

2. 打开 .env 文件，按需更新 PORT 变量，默认值为 4000。

PORT=4000

构建项目

将 TypeScript 代码编译为 JavaScript：

npm run build

编译后的文件将生成在 dist 目录下。

运行服务器

以生产模式运行服务器：

npm start

或者，使用开发模式（带实时重新加载）：

npm run dev

✨ 主要特性

• MCP 集成：运用 MCP SDK 创建服务器，具备工具和提示功能。
• Express 框架：处理 HTTP 端点，用于 SSE 和消息通信。
• 环境配置：利用 .env 文件实现简单配置。
• TypeScript 支持：完整的带类型代码库，提升开发人员体验。

📦 安装指南

开始之前，请确保安装了以下内容：

1. Node.js (v16 或更高) - 下载地址
2. npm（随 Node.js 提供）或 yarn

💻 使用示例

基础用法

使用 MCP 检查器测试和检查你的 MCP 服务器，验证注册的工具和提示是否正确。

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

这将打开一个交互式界面，你可以在其中测试注册在服务器中的工具和提示。

📚 详细文档

该项目是这篇博客文章的一部分：构建 TypeScript MCP 服务器：集成现有服务的指南。访问博客以了解项目背后的概念和实现细节。

🔧 技术细节

以下是项目的概览结构：

hello-world-mcp-server/
├── src/
│   ├── server.ts                     # 主服务器文件
│   ├── index.ts                      # 入口点
│   └── routes/
│       └── exampleRoute.ts          # 示例路由
├── .env                             # 环境变量配置
├── package.json                    # 项目依赖和脚本
├── tsconfig.json                   # TypeScript 配置
└── README.md                       # 项目说明文档

📄 许可证

该项目使用 MIT 许可证。有关详细信息，请参阅LICENSE文件。

🤝 贡献

欢迎贡献！随意提出问题或提交拉取请求。