Hello World MCP Server

Hello World MCP 服务

欢迎使用 Hello World MCP 服务！本项目演示如何使用 Model Context Protocol (MCP) SDK 设置服务。项目包含用于处理服务器发送事件（SSE）和消息的工具、提示词和端点。

本项目是这篇博客文章的一部分：Building a TypeScript MCP Server: A Guide for Integrating Existing Services。访问博客，了解本项目背后的概念和实现细节。

---

功能

• MCP 集成：使用 MCP SDK 创建包含工具和提示词的服务。
• Express 框架：处理用于 SSE 和消息通信的 HTTP 端点。
• 环境配置：使用 .env 文件轻松配置。
• TypeScript 支持：代码库完全采用类型定义，带来更好的开发体验。

---

先决条件

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

1. Node.js（v16 或更高版本） - 在此下载
2. npm（随 Node.js 一起提供）或 yarn

---

开始使用

按照以下步骤设置并运行本项目：

1. 克隆代码库

如果尚未克隆，请将代码库克隆到本地计算机：

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

2. 安装依赖项

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

npm install

或

yarn install

3. 配置环境变量

本项目使用 .env 文件配置服务端口。项目提供了示例文件 .env.example。

1. 将 .env.example 文件复制为 .env：

   cp .env.example .env
   

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

   PORT=4000
   

4. 构建项目

将 TypeScript 代码编译为 JavaScript：

npm run build

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

5. 运行服务

在生产模式下启动服务：

npm start

或者，如需在开发模式下启用实时重新加载，请使用：

npm run dev

---

测试服务

1. 使用 MCP Inspector

MCP Inspector 是用于测试和检查 MCP 服务的工具。你可以使用它来验证工具和提示词是否已正确注册。

运行以下命令检查服务：

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

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

---

项目结构

以下是项目结构概览：

hello-world-mcp-server/
├── src/
│   ├── server.ts                     # Main server entry point
│   ├── modules/
│   │   ├── tools.ts                  # Registers MCP tools
│   │   ├── prompts.ts                # Registers MCP prompts
│   │   └── transports.ts             # Handles SSE and message endpoints
├── .env                              # Environment variables
├── .env.example                      # Example environment variables
├── package.json                      # Project metadata and scripts
├── tsconfig.json                     # TypeScript configuration
└── README.md                         # Project documentation

---

故障排除

常见问题

1. 端口已被占用：如果看到端口被占用的错误，请更新 .env 文件中的 PORT 变量。
2. TypeScript 错误：请确保已安装所有依赖项，并且使用的是正确版本的 Node.js。

调试

使用以下命令调试服务：

npm run dev

这将以实时重新加载和详细日志的方式启动服务。

---

相关项目

• Ollama Pydantic Project：一个配套项目，实现了一个使用本项目所开发工具的 LLM Agent。更多信息请参阅这篇博客文章：Integrating MCP Server with a Local LLM Chatbot。

---

贡献

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

---

许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。