AI导哈

MCP服务器示例

一个使用Model Context Protocol (MCP) SDK构建的服务器示例，支持服务器发送事件(SSE)和消息处理，适用于服务集成和开发测试。

  • by jageenshukla
  • TypeScript
  • 本地部署
  • 15 星标
  • 更新于
在 GitHub 查看 jageenshukla/hello-world-mcp-server

使用说明

Hello World MCP服务器

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

这个项目是博客文章的一部分： 构建TypeScript MCP服务器：集成现有服务指南。访问博客，了解更多关于此项目背后的概念和实施细节。

特性

  • MCP集成：使用MCP SDK创建带有工具和提示的服务器。
  • Express框架：处理SSE和消息通信的HTTP端点。
  • 环境配置：用途 .env 文件，便于配置。
  • TypeScript支持：完全类型化的代码库，以获得更好的开发人员体验。

先决条件

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

  1. Node.js （v16或更高版本）- 点击此处下载
  2. npm （附带Node.js）或 纱线

入门指南

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

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检查器

MCP检查器是一个用于测试和检查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. 端口已在使用中：如果您看到有关正在使用的端口的错误，请更新 PORT 变量在 .env 文件。
  2. TypeScript错误：确保您已安装所有依赖项，并使用正确的Node.js版本。

调试

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

npm run dev

这将通过实时重新加载和详细日志启动服务器。

相关项目

贡献

欢迎投稿！请随时打开问题或提交pull请求。

许可证

该项目根据MIT许可证获得许可。请参阅 许可证 文件以获取详细信息。

相关 MCP