Paylocity

🚀 MCP Paylocity 服務器

MCP Paylocity 服務器是一個模型上下文協議 (MCP) 服務器，主要用於從 Paylocity API 端點獲取數據，為數據獲取和管理提供了便捷的解決方案。

🚀 快速開始

安裝配置

在終端中運行以下命令安裝並啟動服務器：

cd /path/to/mcpPaylocity
npm install
npm start

Claude Desktop 配置

根據環境選擇以下配置方式：

開發環境配置

{
  "development": {
    "command": "uv --directory . run mcppaylocity",
    "args": []
  }
}

發佈環境配置

{
  "production": {
    "command": "uv --directory . run mcppaylocity",
    "args": []
  }
}

✨ 主要特性

資源訪問

• 自定義 URI 方案：使用 paylocity:// 自定義 URI 方案，通過以下路徑訪問 Paylocity 數據：
  • /employees：獲取員工信息。
  • /departments：獲取部門信息。
  • /jobs：獲取職位信息。
  • /salary-slips：獲取工資單信息。

工具實現

• 數據獲取工具：
  • fetch_employees：根據過濾條件（如部門、職位）獲取員工列表。
  • fetch_departments：獲取所有部門信息。
  • fetch_jobs：獲取所有職位信息。
  • fetch_salary_slips：根據員工 ID 獲取工資單詳情。
• 未來計劃：增加高級功能，如績效數據、考勤記錄等，目前仍在開發中。

📦 安裝指南

環境變量配置

為使服務器正常運行，請設置以下環境變量並存入 .env 文件：

注意事項

⚠️ 重要提示

• 認證令牌會緩存到本地文件，確保服務器運行環境的安全性。
• 不要將包含敏感信息的 .env 文件提交到代碼倉庫。

💻 使用示例

基礎用法

由於文檔未提供基礎使用的代碼示例，暫無法展示。

📚 詳細文檔

構建與發佈

1. 構建：

npm run build

2. 打包：

npm run package

3. 發佈：

npm run publish

請確保設置好 npm 用戶令牌或使用環境變量進行認證。

調試技巧

由於 MCP 服務器通過標準輸入輸出運行，調試較為困難。推薦使用 MCP 檢查器 進行調試：

npx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity

運行後，檢查器會顯示瀏覽器訪問地址，幫助您進行調試。

🔧 技術細節

組件結構

1. PaylocityClient：負責與 Paylocity API 進行通信。
2. TokenManager：管理認證令牌的緩存和自動刷新功能。
3. FastMCP 服務器：將 Paylocity 數據通過 MCP 資源和工具對外暴露。

📄 許可證

MIT License

版權所有 (c) 2024 MJ Zou (@mjzou)

許可條款：

允許任何人免費使用、複製、修改、合併、發佈、分發、 sublicensing 和/或出售本軟件及其關聯的文檔文件，前提是遵守以下條件：

• 保留版權聲明：無論以任何形式複製或分發，必須包含版權聲明。
• 限制責任聲明：對於因使用或無法使用本軟件而導致的任何損害（包括但不限於直接、間接、附帶、特殊、衍生或後果性損害），版權所有者不承擔任何責任。