金大哥 - payroll-mcp-server MCP 详情

article

README

🚀 使用 TypeScript 的 MCP 服务器

本项目是一个使用 TypeScript 和 Express 实现的 Model Context Protocol (MCP) 服务器，专注于薪资管理。它借助 MCP 协议，让 AI 模型能以标准方式与外部系统交互，为薪资管理等任务提供支持。

🚀 快速开始

本项目是一个使用 TypeScript 和 Express 搭建的 MCP 服务器，用于薪资管理。以下是快速启动项目的步骤：

确保你的环境满足需求：
- Node.js 18+ 版本
- npm 或 yarn 包管理器
按照安装步骤进行操作：
- 克隆仓库
- 安装依赖：

npm install

- 根据 `.env.example` 模板创建一个 `.env` 文件：

cp .env.example .env

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

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

启动服务器：
- 开发环境：

npm run dev

- 生产环境：

npm run build
npm start

服务器默认在 8089 端口运行，你可在 .env 文件中修改 PORT 变量来更改端口。

✨ 主要特性

MCP 协议实现：实现 MCP 协议用于与大型语言模型 (LLM) 进行交互。
薪资管理功能：提供薪资管理工具和员工信息访问。
HTTP 请求处理：使用 Express 框架处理 HTTP 请求。
实时通信支持：支持服务器发送事件 (SSE) 进行实时通信。
测试客户端：包含一个测试用的示例客户端。

📦 安装指南

克隆仓库：将项目仓库克隆到本地。
安装依赖：

npm install

创建环境文件：根据 .env.example 模板创建 .env 文件。

cp .env.example .env

更新 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 请求认证方法：

使用 authId 和 authKey 的 API 身份验证
使用 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 调用方式。

📄 许可证

[此处插入许可证信息]

payroll-mcp-server