A Simple MCP Server

🚀 一個簡單的MCP服務器

本項目是一個提供用戶數據管理工具的Model Context Protocol (MCP)服務器實現，能有效助力用戶進行數據管理。

✨ 主要特性

• 用戶數據檢索工具：可方便地檢索用戶數據。
• TypeScript實現：保證代碼的類型安全和可維護性。
• ES模塊支持：支持最新的ES模塊規範。
• 內置TypeScript編譯：無需額外配置，方便開發。

📦 安裝指南

先決條件

• Node.js（v20或更高版本）
• npm（v9或更高版本）

安裝步驟

1. 克隆倉庫：

git clone https://github.com/fujahgabriel/simple-mcp-server.git
cd simple-mcp-server

2. 安裝依賴項：

npm install

💻 使用示例

開發

構建項目

要編譯TypeScript文件，可執行以下命令：

npm run build

此命令將完成以下操作：

• 將TypeScript文件編譯為JavaScript。
• 輸出到build目錄。
• 設置輸出文件的正確權限。

開發模式

若要監視更改並自動重新構建，可運行：

npm run watch

使用MCP Inspector

若要檢查和測試您的MCP服務器工具，可按以下步驟操作：

1. 首先構建項目：

npm run build

2. 啟動MCP Inspector：

npm run inspector

3. 檢查器將在http://localhost:5173可用。

MCP配置

若要與Cursor一起使用此MCP服務器，您需要在MCP設置中進行配置。將以下配置添加到您的~/.cursor/mcp.json：

{
  "my-mcp-server": {
    "math": {
      "command": "node",
      "args": ["build/index.js"]
    }
  }
}

請確保：

1. 首先使用npm run build構建項目。
2. 使用正確路徑的構建JavaScript文件。
3. 更新配置後重新啟動Cursor。

可用工具

get_users

檢索所有用戶列表。

get_user

按名稱檢索特定用戶。 參數：

• user: string - 要檢索的用戶名

📚 詳細文檔

項目結構

mcp-server/
├── build/           # 編譯後的JavaScript文件
├── index.ts         # 主服務器實現
├── package.json     # 項目依賴和腳本
└── tsconfig.json    # TypeScript配置

依賴項

• @modelcontextprotocol/sdk: MCP SDK用於服務器實現。
• dotenv: 環境變量管理。
• typescript: TypeScript編譯器。
• zod: 運行時類型驗證。

📄 許可證

本項目採用MIT許可證。