TypeScript MCP Server

TypeScript MCP Server

site icon
2025.04.15 0
TypeScript薪资管理员工信息管理金融服务
payroll-mcp-server 是一个基于 TypeScript 和 Express 的 Model Context Protocol (MCP) 服务器实现,专注于薪资管理。它提供了一个标准化的框架,使 AI 模型能够与外部系统交互,执行薪资管理任务。
View on GitHub

Overview

基本能力

产品定位

payroll-mcp-server 是一个用于薪资管理的 MCP 服务器,通过标准化的协议使 AI 模型能够访问和管理薪资数据。

核心功能

  • 实现 MCP 协议,支持 LLM 交互
  • 提供薪资管理工具和员工信息访问
  • 使用 Express 处理 HTTP 请求
  • 支持 Server-Sent Events (SSE) 实现实时通信
  • 包含测试用的客户端示例

适用场景

  • 企业薪资管理系统
  • 员工信息查询系统
  • 薪资计算自动化

工具列表

  • view-people: 查看特定员工的详细信息(需 authId 和 authKey 认证)
  • view-all-people: 查看所有员工信息,支持筛选和分页(支持 API 认证或合作伙伴认证)
  • getEmployeeInfo: 获取员工基本信息(姓名、部门、角色)
  • calculatePayroll: 计算员工薪资(基于工作小时和小时费率)

常见问题解答

  • 如何修改认证方式?可以修改 src/api.ts 文件来满足自定义认证需求。
  • 如何更改服务器端口?在 .env 文件中设置 PORT 环境变量。

使用教程

使用依赖

  • Node.js 18+
  • npm 或 yarn

安装教程

  1. 克隆仓库
  2. 安装依赖:
npm install
  1. 创建 .env 文件:
cp .env.example .env
  1. 更新 .env 文件中的 API 配置:
# API configuration
BASE_URL=http://app.localopfin.com
PORT=8089

运行服务器

开发模式:

npm run dev

生产模式:

npm run build
npm start

调试方式

运行示例客户端(需先启动服务器):

npm run client

客户端将: 1. 连接到 MCP 服务器 2. 列出可用资源、工具和提示 3. 读取欢迎资源 4. 使用可用工具 5. 获取提问提示

许可证

该项目遵循 MIT 开源许可条款。