TypeScript MCP Server

TypeScript MCP 服务

使用 TypeScript 和 Express 实现的薪资管理模型上下文协议（MCP）服务。

什么是 MCP？

模型上下文协议（MCP）使 AI 模型能够以标准化的方式与外部系统交互。它提供了一个框架，用于定义大模型可用来执行任务的资源、工具和提示词。

如需了解更多信息，请访问 Model Context Protocol 仓库。

功能

• 实现用于大模型交互的 MCP 协议
• 提供薪资管理工具和员工信息访问功能
• 使用 Express 处理 HTTP 请求
• 支持通过服务器发送事件（SSE）进行实时通信
• 包含用于测试的客户端示例

要求

• Node.js 18+
• npm 或 yarn

安装

1. 克隆仓库
2. 安装依赖：

npm install

3. 根据 .env.example 模板创建 .env 文件：

cp .env.example .env

4. 使用你的 API 配置更新 .env 文件：

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

运行服务

使用以下命令启动开发服务：

npm run dev

用于生产环境：

npm run build
npm start

服务默认运行在端口 8089 上。你可以通过在 .env 文件中设置 PORT 环境变量来更改端口。

身份验证

此服务支持两种 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 进行合作伙伴身份验证）
• getEmployeeInfo：简化的员工信息检索工具，根据员工 ID 返回基本员工数据（姓名、部门、职位）
• calculatePayroll：根据员工的工作时长和时薪计算薪资（计算税前工资、20% 的税款和税后工资）

可用接口

项目包含用于 API 响应的类型化接口：

• ApiResponse<T>：包含 data、error 和 status 字段的通用 API 响应封装
• ApiConfig：用于 API 客户端的配置，包含 baseUrl 和可选的 headers
• ApiCredentials：用于基于 API 的身份验证，包含 authId 和 authKey
• PartnerCredentials：用于基于合作伙伴的身份验证，包含 partnerKey 和 clientKey

这些接口有助于确保处理 API 数据时的类型安全。

可用提示词

• ask-question：用于提问的提示词模板

使用示例客户端进行测试

仓库包含一个示例客户端，演示如何连接 MCP 服务并使用其资源、工具和提示词。

（服务已运行时）运行示例客户端：

npm run client

此操作将：

1. 连接到 MCP 服务
2. 列出可用的资源、工具和提示词
3. 读取问候资源
4. 使用可用工具
5. 获取 ask-question 提示词

与大模型搭配使用

此 MCP 服务可与支持 MCP 协议的大模型客户端搭配使用。请参阅 MCP 文档，了解如何将大模型客户端连接到此服务。

许可证

MIT