Paylocity Data Fetcher

🚀 MCP Paylocity Server

A Model Context Protocol (MCP) server for fetching data from Paylocity API endpoints.

✨ Features

Resources

This server implements Paylocity API resources with:

• A custom paylocity:// URI scheme for accessing Paylocity data.
• Available resources include:
  • paylocity://employees/{company_id} - List all employees of a company.
  • paylocity://employees/{company_id}/{employee_id} - Get detailed information of a specific employee.
  • paylocity://earnings/{company_id}/{employee_id} - Get the earnings data of a specific employee.
  • paylocity://codes/{company_id}/{code_resource} - Get codes for a specific resource of a company.
  • paylocity://localtaxes/{company_id}/{employee_id} - Get local tax information of a specific employee.
  • paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date} - Get detailed information of a pay statement on a specific date.

Tools

This server implements the following tools:

• fetch_employees - Fetch all employees of a company.
  • Optional parameter: company_id
• fetch_employee_details - Fetch detailed information of a specific employee.
  • Required parameter: employee_id, Optional parameter: company_id
• fetch_employee_earnings - Fetch the earnings data of a specific employee.
  • Required parameter: employee_id, Optional parameter: company_id
• fetch_company_codes - Fetch codes for a specific resource of a company.
  • Required parameter: code_resource, Optional parameter: company_id
• fetch_employee_local_taxes - Fetch local tax information of a specific employee.
  • Required parameter: employee_id, Optional parameter: company_id
• fetch_employee_paystatement_details - Fetch detailed information of a pay statement on a specific date.
  • Required parameters: employee_id, year, and check_date, Optional parameter: company_id

📚 Documentation

Future Plans

Future improvements include:

• Adding detailed error handling and logging functionality.
• Implementing a more efficient caching mechanism to improve performance.
• Supporting data synchronization for multiple companies.
• Providing more API endpoints to enhance functionality.
• Optimizing the code structure to make it more modular and easier to maintain.

📄 License

MIT License

Copyright (c) 2024 MJ Zou (@mjzou)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.