你好世界MCP服务器
项目介绍
Hello World MCP Server
欢迎来到Hello World MCP Server！该项目演示了如何使用模型上下文协议（MCP）SDK来设置一个服务器。它包括用于处理服务器发送事件（SSE）和消息的工具、提示和端点。
该项目是博客文章的一部分：构建一个TypeScript MCP服务器：集成现有服务指南。访问该博客以了解更多关于此项目的概念和实现细节。
特性
- MCP集成：使用MCP SDK创建带有工具和提示的服务器。
- Express框架：处理HTTP端点，用于SSE和消息通信。
- 环境配置：使用
.env文件进行简单配置。 - TypeScript支持：完全类型化的代码库，提供更好的开发者体验。
先决条件
在开始之前，请确保已安装以下内容：
- Node.js（v16或更高版本） - 下载地址
- 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文件。
-
将
.env.example文件复制为.env：cp .env.example .env -
打开
.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 # 项目文档
故障排除
常见问题
- 端口已被占用：如果您看到有关端口被占用的错误，请更新
.env文件中的PORT变量。 - TypeScript错误：确保您已安装所有依赖项，并且使用的是正确的Node.js版本。
调试
使用以下命令调试服务器：
npm run dev
这将以实时重新加载和详细日志的方式启动服务器。
相关项目
- Ollama Pydantic Project：一个反向项目，实现了利用本项目开发的工具的LLM代理。更多详情请参阅博客文章：将MCP服务器与本地LLM聊天机器人集成。
贡献
欢迎贡献！请随意打开问题或提交拉取请求。
许可证
本项目采用MIT许可证。详情请参阅LICENSE文件。