paychex-mcp-server

🚀 佩查克斯 MCP 服务器

本项目是一个具备演示性质的 MCP（机器上下文协议）服务器，其主要功能是与 Paychex 开发者 API 文档进行交互。该服务器支持多种大语言模型（LLM），可高效处理针对 Paychex 文档的查询需求。

🚀 快速开始

若要使用本项目，可按照以下步骤操作：

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

   npm install
   

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

   cp .env.example .env
   

4. 使用你的 API 密钥编辑 .env 文件。

之后，你可以选择以下模式启动项目：

开发模式

npm run dev

生产模式

npm start

✨ 主要特性

• 能够连接到 Paychex 开发者 API 文档。
• 支持多个 LLM 供应商，如 OpenAI、Anthropic 等。
• 基于安全密钥管理进行环境配置。
• 提供 RESTful API 端点，可使用 LLM 查询 Paychex 数据。

📦 安装指南

克隆仓库

将项目仓库克隆到本地：

git clone [仓库地址]

安装依赖

在项目根目录下执行以下命令安装依赖：

npm install

配置环境变量

根据 .env.example 创建 .env 文件，并使用你的 API 密钥进行编辑：

cp .env.example .env

在 .env 文件中需要配置以下环境变量：

# 服务器配置
PORT=3000

# Paychex API密钥
PAYCHEX_API_KEY=你的API密钥
PAYCHEX_CLIENT_ID=你的客户端ID
PAYCHEX_CLIENT_SECRET=你的客户端秘密

# LLM配置
LLM_TYPE=openai  # 选项：openai、anthropic、azure等
LLM_API_KEY=你的LLM API密钥
OPENAI_API_KEY=你的OpenAI密钥
ANTHROPIC_API_KEY=你的Anthropic密钥

💻 使用示例

基础用法

在开发模式下启动服务器：

npm run dev

在生产模式下启动服务器：

npm start

高级用法

使用 API 端点进行数据查询：

获取 Paychex 数据

GET /api/paychex/data?endpoint=可选端点路径

此请求将返回来自 Paychex API 文档的原始数据。

使用 LLM 查询

POST /api/paychex/query

请求体示例：

{
  "query": "有哪些可用的Paychex API？",
  "endpoint": "可选端点路径"
}

该请求将使用配置的 LLM 对 Paychex 文档进行查询。

📚 详细文档

API 端点

获取 Paychex 数据

GET /api/paychex/data?endpoint=可选端点路径

返回来自 Paychex API 文档的原始数据。

使用 LLM 查询

POST /api/paychex/query

请求体：

{
  "query": "有哪些可用的Paychex API？",
  "endpoint": "可选端点路径"
}

使用配置的 LLM 对 Paychex 文档进行查询。

扩展功能

添加新的 LLM 供应商

若要添加对新 LLM 供应商的支持，可按以下步骤操作：

1. 在 services/llm.js 中添加一个新的服务类。
2. 更新 getLLMService() 函数以处理新的供应商。
3. 将必要的环境变量添加到 .env.example。

📄 许可证

免责声明

这是一个演示项目，仅用于说明用途。它与佩查克斯公司无任何官方关联或认可。