Paylocity Data Fetcher

🚀 MCP Paylocity 服務器

MCP Paylocity 服務器是一個基於模型上下文協議（MCP）的服務器，主要用於從 Paylocity API 端點獲取數據，為用戶提供便捷的數據訪問服務。

🚀 快速開始

本服務器可直接使用，通過特定的 URI 方案和工具即可訪問 Paylocity 數據。

✨ 主要特性

• 自定義 URI 方案：使用 paylocity:// 自定義 URI 方案，方便快捷地訪問 Paylocity 數據。
• 豐富的資源和工具：提供多種資源和工具，可滿足不同場景下對 Paylocity 數據的獲取需求。

📦 安裝指南

暫未提供安裝步驟相關內容。

💻 使用示例

基礎用法

# 以下是使用工具獲取員工信息的示例
# 假設已經有了合適的 company_id 和 employee_id

# 獲取公司的所有員工
fetch_employees(company_id='your_company_id')

# 獲取特定員工的詳細信息
fetch_employee_details(company_id='your_company_id', employee_id='your_employee_id')

高級用法

# 高級場景說明：可以根據不同的需求組合使用工具，獲取更全面的數據
# 例如，先獲取公司所有員工，再遍歷獲取每個員工的詳細信息和收入數據

employees = fetch_employees(company_id='your_company_id')
for employee in employees:
    employee_id = employee.get('id')
    employee_details = fetch_employee_details(company_id='your_company_id', employee_id=employee_id)
    employee_earnings = fetch_employee_earnings(company_id='your_company_id', employee_id=employee_id)
    print(f"Employee {employee_id} details: {employee_details}, earnings: {employee_earnings}")

📚 詳細文檔

組件

資源

該服務器實現了 Paylocity API 資源，具有以下特點：

• 自定義 paylocity:// URI 方案，用於訪問 Paylocity 數據。
• 可用的資源包括：
  • paylocity://employees/{company_id} - 列出公司所有員工。
  • paylocity://employees/{company_id}/{employee_id} - 獲取特定員工的詳細信息。
  • paylocity://earnings/{company_id}/{employee_id} - 獲取特定員工的收入數據。
  • paylocity://codes/{company_id}/{code_resource} - 獲取公司特定資源的代碼。
  • paylocity://localtaxes/{company_id}/{employee_id} - 獲取特定員工的地方稅信息。
  • paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date} - 獲取特定日期的工資單詳細信息。

工具

該服務器實現了以下工具：

🔧 技術細節

暫未提供技術實現細節相關內容。

📄 許可證

本項目採用 MIT License 進行許可。

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

許可方在此授予任何獲得該軟件及其關聯文檔文件（“軟件”）副本的人免費使用、複製、修改、合併、發佈、分發、 sublicense 和/或出售該軟件的權利，以及允許向獲得該軟件的人提供該軟件以便其進行上述行為，但需遵守以下條件：

本版權聲明和本許可聲明應包含在所有副本或該軟件的所有實質性部分中。

軟件按“現狀”提供，不附帶任何形式的保證，包括但不限於明示或暗示的保證，如適銷性、特定用途適用性以及非侵權保證。無論是在合同行為、侵權行為或其他任何行為中，作者或版權持有者均不對因使用該軟件而產生的任何聲明、損害或其他責任承擔任何責任。