Payroll MCP Server

🚀 使用 TypeScript 的 MCP 服務器

本項目是一個使用 TypeScript 和 Express 實現的 Model Context Protocol (MCP) 服務器，專注於薪資管理。它藉助 MCP 協議，讓 AI 模型能以標準方式與外部系統交互，為薪資管理等任務提供支持。

🚀 快速開始

本項目是一個使用 TypeScript 和 Express 搭建的 MCP 服務器，用於薪資管理。以下是快速啟動項目的步驟：

1. 確保你的環境滿足需求：
   • Node.js 18+ 版本
   • npm 或 yarn 包管理器
2. 按照安裝步驟進行操作：
   • 克隆倉庫
   • 安裝依賴：

npm install

- 根據 `.env.example` 模板創建一個 `.env` 文件：

cp .env.example .env

- 在 `.env` 文件中更新 API 配置：

# API 配置
BASE_URL=http://app.localopfin.com
PORT=8089

3. 啟動服務器：
   • 開發環境：

npm run dev

- 生產環境：

npm run build
npm start

服務器默認在 8089 端口運行，你可在 .env 文件中修改 PORT 變量來更改端口。

✨ 主要特性

• MCP 協議實現：實現 MCP 協議用於與大型語言模型 (LLM) 進行交互。
• 薪資管理功能：提供薪資管理工具和員工信息訪問。
• HTTP 請求處理：使用 Express 框架處理 HTTP 請求。
• 即時通信支持：支持服務器發送事件 (SSE) 進行即時通信。
• 測試客戶端：包含一個測試用的示例客戶端。

📦 安裝指南

1. 克隆倉庫：將項目倉庫克隆到本地。
2. 安裝依賴：

npm install

3. 創建環境文件：根據 .env.example 模板創建 .env 文件。

cp .env.example .env

4. 更新 API 配置：在 .env 文件中更新 API 配置。

# API 配置
BASE_URL=http://app.localopfin.com
PORT=8089

💻 使用示例

基礎用法

啟動開發服務器：

npm run dev

高級用法

在生產環境中運行服務器：

npm run build
npm start

📚 詳細文檔

什麼是 MCP？

Model Context Protocol (MCP) 使 AI 模型能夠以一種標準的方式與外部系統交互。它提供了一個框架來定義資源、工具和提示，供大型語言模型 (LLM) 使用以執行任務。有關更多信息，請訪問 Model Context Protocol 倉庫。

認證

此服務器支持兩種 API 請求認證方法：

1. 使用 authId 和 authKey 的 API 身份驗證
2. 使用 partnerKey 和 clientKey 的合作伙伴身份驗證

如需自定義認證需求，可以修改 src/api.ts 文件。

API 端點

• GET /sse：用於 MCP 通信的服務器發送事件端點。
• POST /messages：客戶端向 MCP 服務器發送消息的端點。

可用資源

• greeting://welcome：靜態歡迎消息資源。
• users://{userId}：返回用戶數據的動態資源。

可用工具

• view-people：使用員工 ID 查看特定人員信息（需要 authId 和 authKey 認證）。
• view-all-people：查看所有人員，支持可選過濾和分頁（支持使用 authId/authKey 的 API 身份驗證或 partnerKey/clientKey 的合作伙伴身份驗證）。
• add-employee：添加新員工到系統中。
• remove-employee：從系統中刪除指定員工。

可用接口

• EmployeeService 類型定義了與員工相關的操作接口。
• SystemService 類型定義了系統級的操作接口。

如需使用這些工具，請參考項目文檔或示例代碼。

提示

本項目包含一個測試客戶端，您可以運行：

npm run client

以驗證服務器功能和 API 調用方式。

📄 許可證

[此處插入許可證信息]