Hello World MCP 服务器

欢迎来到 Hello World MCP 服务器！ 本项目演示了如何使用 模型上下文协议 (MCP) SDK 设置服务器。 它包括用于处理服务器发送事件 (SSE) 和消息的工具、提示和端点。

---

特性

• 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                     # 主服务器入口点
│   ├── modules/
│   │   ├── tools.ts                  # 注册 MCP 工具
│   │   ├── prompts.ts                # 注册 MCP 提示
│   │   └── transports.ts             # 处理 SSE 和消息端点
├── .env                              # 环境变量
├── .env.example                      # 示例环境变量
├── package.json                      # 项目元数据和脚本
├── tsconfig.json                     # TypeScript 配置
└── README.md                         # 项目文档

---

故障排除

常见问题

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

调试

使用以下命令调试服务器：

npm run dev

这将启动具有实时重新加载和详细日志的服务器。

---

贡献

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

---

许可证

本项目根据 ISC 许可证获得许可。 有关详细信息，请参阅 LICENSE 文件。