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文件。

🤝 貢獻

歡迎貢獻！隨意提出問題或提交拉取請求。