[{"_1":2,"_354":-5,"_355":-5},"loaderData",{"_3":4,"_22":23,"_275":276},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"bot","id",21617481,"membership","referenceId","019a2dfc-1dad-704d-a3b8-88a103e988d5","userAccount","routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_24":25,"_63":-5,"_64":26,"_27":65,"_190":191,"_273":274},"availableLocales",[26,38,44,50,57],{"_27":28,"_31":35,"_36":37},"mcpServer",{"_29":30,"_31":32,"_33":34},"description","An MCP server that provides access to Paylocity API endpoints, allowing retrieval of employee data, earnings, company codes, local taxes, and pay statements.","name","mcpPaylocity","readme","# mcpPaylocity MCP Server\n[![smithery badge](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\nA Model Context Protocol (MCP) server to fetch data from Paylocity API endpoints.\n\n## Components\n\n### Resources\n\nThe server implements Paylocity API resources with:\n- Custom `paylocity://` URI scheme for accessing Paylocity data\n- The following resources are available:\n - `paylocity://employees/{company_id}` - List all employees for a company\n - `paylocity://employees/{company_id}/{employee_id}` - Get details for a specific employee\n - `paylocity://earnings/{company_id}/{employee_id}` - Get earnings data for a specific employee\n - `paylocity://codes/{company_id}/{code_resource}` - Get company codes for a specific resource\n - `paylocity://localtaxes/{company_id}/{employee_id}` - Get local taxes for a specific employee\n - `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - Get pay statement details for a specific date\n\n### Tools\n\nThe server implements the following tools:\n- `fetch_employees` - Fetches all employees for a company\n - Takes optional `company_id` parameter\n- `fetch_employee_details` - Fetches details for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_employee_earnings` - Fetches earnings data for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_company_codes` - Fetches company codes for a specific resource\n - Takes required `code_resource` and optional `company_id` parameters\n- `fetch_employee_local_taxes` - Fetches local taxes for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_employee_paystatement_details` - Fetches pay statement details for a specific date\n - Takes required `employee_id`, `year`, `check_date` and optional `company_id` parameters\n\n## Future Implementations\n\nThe following endpoints will be implemented in future updates:\n\n- [ ] Higher level insights (e.g. turnover rate, headcount by department, rate comparison etc.)\n\n## Configuration\n\nThe server requires the following environment variables to be set:\n- `PAYLOCITY_CLIENT_ID` - Your Paylocity API client ID\n- `PAYLOCITY_CLIENT_SECRET` - Your Paylocity API client secret\n- `PAYLOCITY_COMPANY_IDS` - Comma-separated list of company IDs to use\n- `PAYLOCITY_ENVIRONMENT` - API environment to use (`production` or `testing`)\n\nThese can be set in a `.env` file in the project root directory.\n\n## Security\n\n⚠️ **IMPORTANT**: This application caches authentication tokens in the `src/mcppaylocity/access_token/` directory. These files contain sensitive credentials and should **never** be committed to version control.\n\nThe repository includes these paths in `.gitignore`, but please verify that token files are not accidentally committed when pushing changes.\n\nIf you've accidentally committed token files, follow these steps:\n1. Remove the files from the repository: `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. Commit the removal: `git commit -m \"Remove accidentally committed token files\"`\n3. Consider rotating your Paylocity API credentials as they may have been compromised\n\n## Quickstart\n\n### Install\n\n#### Claude Desktop\n\nOn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json`\nOn Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n

Development/Unpublished Servers Configuration

\n \n ```json\n \"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcpPaylocity\",\n \"run\",\n \"mcppaylocity\"\n ]\n }\n }\n ```\n

\n\n

Published Servers Configuration

\n \n ```json\n \"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n }\n ```\n

\n\n## Development\n\n### Building and Publishing\n\nTo prepare the package for distribution:\n\n1. Sync dependencies and update lockfile:\n```bash\nuv sync\n```\n\n2. Build package distributions:\n```bash\nuv build\n```\n\nThis will create source and wheel distributions in the `dist/` directory.\n\n3. Publish to PyPI:\n```bash\nuv publish\n```\n\nNote: You'll need to set PyPI credentials via environment variables or command flags:\n- Token: `--token` or `UV_PUBLISH_TOKEN`\n- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`\n\n### Debugging\n\nSince MCP servers run over stdio, debugging can be challenging. For the best debugging\nexperience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).\n\nYou can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity\n```\n\nUpon launching, the Inspector will display a URL that you can access in your browser to begin debugging.\n\n## Architecture\n\nThe server is built with the following components:\n\n1. **PaylocityClient** - Handles communication with the Paylocity API\n2. **TokenManager** - Manages authentication tokens, including caching and renewal\n3. **FastMCP Server** - Exposes Paylocity data through MCP resources and tools\n\n## License\n\nMIT License\n\nCopyright (c) 2024 MJ Zou ([@mjzou](https://www.linkedin.com/in/mjzou/))\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","English","tag","en-US",{"_27":39,"_31":42,"_36":43},{"_29":40,"_31":32,"_33":41},"Un servidor MCP que proporciona acceso a los puntos finales de la API de Paylocity, lo que permite la recuperación de datos de empleados, ganancias, códigos de empresa, impuestos locales y declaraciones de pago.","# Servidor MCP de mcpPaylocity\n\n[![insignia de herrería](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\nUn servidor de Protocolo de contexto de modelo (MCP) para obtener datos de los puntos finales de la API de Paylocity.\n\n## Componentes\n\n### Recursos\n\nEl servidor implementa recursos de API de Paylocity con:\n\n* Esquema de URI `paylocity://` personalizado para acceder a los datos de Paylocity\n* Los siguientes recursos están disponibles:\n * `paylocity://employees/{company_id}` - Lista todos los empleados de una empresa\n * `paylocity://employees/{company_id}/{employee_id}` - Obtener detalles de un empleado específico\n * `paylocity://earnings/{company_id}/{employee_id}` - Obtener datos de ganancias de un empleado específico\n * `paylocity://codes/{company_id}/{code_resource}` - Obtener códigos de empresa para un recurso específico\n * `paylocity://localtaxes/{company_id}/{employee_id}` - Obtener los impuestos locales de un empleado específico\n * `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - Obtener detalles del estado de pago para una fecha específica\n\n### Herramientas\n\nEl servidor implementa las siguientes herramientas:\n\n* `fetch_employees` : obtiene todos los empleados de una empresa\n * Toma el parámetro `company_id` opcional\n* `fetch_employee_details` : obtiene detalles de un empleado específico\n * Toma los parámetros requeridos `employee_id` y opcionales `company_id`\n* `fetch_employee_earnings` : obtiene datos de ganancias de un empleado específico\n * Toma los parámetros requeridos `employee_id` y opcionales `company_id`\n* `fetch_company_codes` : obtiene códigos de empresa para un recurso específico\n * Toma los parámetros obligatorios `code_resource` y `company_id` opcionales\n* `fetch_employee_local_taxes` : obtiene los impuestos locales de un empleado específico\n * Toma los parámetros requeridos `employee_id` y opcionales `company_id`\n* `fetch_employee_paystatement_details` : obtiene los detalles del extracto de pago para una fecha específica\n * Toma los parámetros obligatorios `employee_id` , `year` , `check_date` y `company_id` opcional.\n\n## Implementaciones futuras\n\nLos siguientes puntos finales se implementarán en futuras actualizaciones:\n\n* \\[ ] Información de nivel superior (por ejemplo, tasa de rotación, plantilla por departamento, comparación de tarifas, etc.)\n\n## Configuración\n\nEl servidor requiere que se configuren las siguientes variables de entorno:\n\n* `PAYLOCITY_CLIENT_ID` - Su ID de cliente de la API de Paylocity\n* `PAYLOCITY_CLIENT_SECRET` - Su secreto de cliente de la API de Paylocity\n* `PAYLOCITY_COMPANY_IDS` - Lista separada por comas de identificaciones de empresas para usar\n* `PAYLOCITY_ENVIRONMENT` - Entorno API a utilizar ( `production` o `testing` )\n\nEstos se pueden configurar en un archivo `.env` en el directorio raíz del proyecto.\n\n## Seguridad\n\n⚠️ **IMPORTANTE** : Esta aplicación almacena en caché los tokens de autenticación en el directorio `src/mcppaylocity/access_token/` . Estos archivos contienen credenciales confidenciales y **nunca** deben enviarse al control de versiones.\n\nEl repositorio incluye estas rutas en `.gitignore` , pero verifique que los archivos de token no se confirmen accidentalmente al enviar cambios.\n\nSi ha enviado archivos de token accidentalmente, siga estos pasos:\n\n1. Eliminar los archivos del repositorio: `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. Confirmar la eliminación: `git commit -m \"Remove accidentally committed token files\"`\n3. Considere rotar sus credenciales de API de Paylocity, ya que podrían haber sido comprometidas\n\n## Inicio rápido\n\n### Instalar\n\n#### Escritorio de Claude\n\nEn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json` En Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcpPaylocity\",\n \"run\",\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n## Desarrollo\n\n### Construcción y publicación\n\nPara preparar el paquete para su distribución:\n\n1. Sincronizar dependencias y actualizar archivo de bloqueo:\n\n```bash\nuv sync\n```\n\n2. Distribuciones de paquetes de compilación:\n\n```bash\nuv build\n```\n\nEsto creará distribuciones de origen y de rueda en el directorio `dist/` .\n\n3. Publicar en PyPI:\n\n```bash\nuv publish\n```\n\nNota: Deberás configurar las credenciales de PyPI a través de variables de entorno o indicadores de comando:\n\n* Token: `--token` o `UV_PUBLISH_TOKEN`\n* O nombre de usuario/contraseña: `--username` / `UV_PUBLISH_USERNAME` y `--password` / `UV_PUBLISH_PASSWORD`\n\n### Depuración\n\nDado que los servidores MCP se ejecutan en stdio, la depuración puede ser complicada. Para una experiencia óptima, recomendamos usar el [Inspector MCP](https://github.com/modelcontextprotocol/inspector) .\n\nPuede iniciar el Inspector MCP a través de [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) con este comando:\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity\n```\n\nAl iniciarse, el Inspector mostrará una URL a la que podrá acceder en su navegador para comenzar a depurar.\n\n## Arquitectura\n\nEl servidor está construido con los siguientes componentes:\n\n1. **PaylocityClient** : gestiona la comunicación con la API de Paylocity\n2. **TokenManager** : administra tokens de autenticación, incluido el almacenamiento en caché y la renovación.\n3. **Servidor FastMCP** : expone datos de Paylocity a través de recursos y herramientas de MCP\n\n## Licencia\n\nLicencia MIT\n\nCopyright (c) 2024 MJ Zou ( [@mjzou](https://www.linkedin.com/in/mjzou/) )\n\nPor la presente se concede permiso, sin cargo, a cualquier persona que obtenga una copia de este software y los archivos de documentación asociados (el \"Software\"), para tratar el Software sin restricción, incluyendo, sin limitación, los derechos a usar, copiar, modificar, fusionar, publicar, distribuir, sublicenciar y/o vender copias del Software, y para permitir que las personas a quienes se les proporciona el Software lo hagan, sujeto a las siguientes condiciones:\n\nEl aviso de derechos de autor anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.\n\nEL SOFTWARE SE PROPORCIONA \"TAL CUAL\", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA, INCLUYENDO, ENTRE OTRAS, LAS GARANTÍAS DE COMERCIABILIDAD, IDONEIDAD PARA UN FIN DETERMINADO Y NO INFRACCIÓN. EN NINGÚN CASO LOS AUTORES O TITULARES DE LOS DERECHOS DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN, DAÑOS U OTRAS RESPONSABILIDADES, YA SEA EN ACCIÓN CONTRACTUAL, EXTRACONTRACTUAL O DE OTRO TIPO, QUE SURJA DE, SE DERIVE DE O EN RELACIÓN CON EL SOFTWARE O EL USO U OTRAS RELACIONES CON EL MISMO.","Spanish","es-ES",{"_27":45,"_31":48,"_36":49},{"_29":46,"_31":32,"_33":47},"Paylocity API エンドポイントへのアクセスを提供し、従業員データ、収入、会社コード、地方税、給与明細の取得を可能にする MCP サーバー。","# mcpPaylocity MCP サーバー\n\n[![鍛冶屋のバッジ](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\nPaylocity API エンドポイントからデータを取得するためのモデルコンテキストプロトコル (MCP) サーバー。\n\n## コンポーネント\n\n### リソース\n\nサーバーは、次の Paylocity API リソースを実装します。\n\n* Paylocity データにアクセスするためのカスタム`paylocity://` URI スキーム\n* 利用可能なリソースは次のとおりです。\n * `paylocity://employees/{company_id}` - 会社の全従業員を一覧表示する\n * `paylocity://employees/{company_id}/{employee_id}` - 特定の従業員の詳細を取得します\n * `paylocity://earnings/{company_id}/{employee_id}` - 特定の従業員の収入データを取得する\n * `paylocity://codes/{company_id}/{code_resource}` - 特定のリソースの会社コードを取得します\n * `paylocity://localtaxes/{company_id}/{employee_id}` - 特定の従業員の地方税を取得します\n * `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - 特定の日付の給与明細の詳細を取得します\n\n### ツール\n\nサーバーは次のツールを実装します。\n\n* `fetch_employees` - 会社のすべての従業員を取得します\n * オプションの`company_id`パラメータを取る\n* `fetch_employee_details` - 特定の従業員の詳細を取得します\n * 必須の`employee_id`とオプションの`company_id`パラメータを取ります\n* `fetch_employee_earnings` - 特定の従業員の収入データを取得します\n * 必須の`employee_id`とオプションの`company_id`パラメータを取ります\n* `fetch_company_codes` - 特定のリソースの会社コードを取得します\n * 必須の`code_resource`とオプションの`company_id`パラメータを取ります\n* `fetch_employee_local_taxes` - 特定の従業員の地方税を取得します\n * 必須の`employee_id`とオプションの`company_id`パラメータを取ります\n* `fetch_employee_paystatement_details` - 特定の日付の給与明細の詳細を取得します\n * 必須の`employee_id` 、 `year` 、 `check_date` 、およびオプションの`company_id`パラメータを取ります。\n\n## 将来の実装\n\n今後のアップデートでは、次のエンドポイントが実装される予定です。\n\n* \\[ ] 高レベルの洞察（例：離職率、部門別の従業員数、レートの比較など）\n\n## 構成\n\nサーバーでは次の環境変数を設定する必要があります。\n\n* `PAYLOCITY_CLIENT_ID` - Paylocity APIクライアントID\n* `PAYLOCITY_CLIENT_SECRET` - Paylocity APIクライアントシークレット\n* `PAYLOCITY_COMPANY_IDS` - 使用する会社IDのカンマ区切りリスト\n* `PAYLOCITY_ENVIRONMENT` - 使用する API 環境 ( `production`または`testing` )\n\nこれらは、プロジェクトのルートディレクトリ内の`.env`ファイルで設定できます。\n\n## 安全\n\n⚠️**重要**：このアプリケーションは認証トークンを`src/mcppaylocity/access_token/`ディレクトリにキャッシュします。これらのファイルには機密性の高い認証情報が含まれているため、バージョン管理にコミットし**ない**でください。\n\nリポジトリには`.gitignore`にこれらのパスが含まれていますが、変更をプッシュするときにトークンファイルが誤ってコミットされないように注意してください。\n\n誤ってトークンファイルをコミットした場合は、次の手順に従ってください。\n\n1. リポジトリからファイルを削除します: `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. 削除をコミットします: `git commit -m \"Remove accidentally committed token files\"`\n3. Paylocity APIの認証情報が侵害されている可能性があるため、ローテーションを検討してください。\n\n## クイックスタート\n\n### インストール\n\n#### クロードデスクトップ\n\nMacOS の場合: `~/Library/Application\\ Support/Claude/claude_desktop_config.json` Windows の場合: `%APPDATA%/Claude/claude_desktop_config.json`\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcpPaylocity\",\n \"run\",\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n## 発達\n\n### 建築と出版\n\n配布用のパッケージを準備するには:\n\n1. 依存関係を同期し、ロックファイルを更新します。\n\n```bash\nuv sync\n```\n\n2. パッケージディストリビューションをビルドします。\n\n```bash\nuv build\n```\n\nこれにより、 `dist/`ディレクトリにソースとホイールのディストリビューションが作成されます。\n\n3. PyPI に公開:\n\n```bash\nuv publish\n```\n\n注: 環境変数またはコマンドフラグを使用して PyPI 資格情報を設定する必要があります。\n\n* トークン: `--token`または`UV_PUBLISH_TOKEN`\n* またはユーザー名/パスワード: `--username` / `UV_PUBLISH_USERNAME`および`--password` / `UV_PUBLISH_PASSWORD`\n\n### デバッグ\n\nMCPサーバーはstdio経由で実行されるため、デバッグが困難になる場合があります。最適なデバッグ環境を実現するには、 [MCP Inspectorの](https://github.com/modelcontextprotocol/inspector)使用を強くお勧めします。\n\n次のコマンドを使用して、 [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)経由で MCP Inspector を起動できます。\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity\n```\n\n起動すると、ブラウザでアクセスしてデバッグを開始できる URL がインスペクタに表示されます。\n\n## 建築\n\nサーバーは次のコンポーネントで構築されています。\n\n1. **PaylocityClient** - Paylocity APIとの通信を処理します\n2. **TokenManager** - キャッシュや更新を含む認証トークンを管理します\n3. **FastMCP Server** - MCPのリソースとツールを通じてPaylocityデータを公開します\n\n## ライセンス\n\nMITライセンス\n\nCopyright (c) 2024 MJ Zou ( [@mjzou](https://www.linkedin.com/in/mjzou/) )\n\n本ソフトウェアおよび関連ドキュメントファイル (以下「本ソフトウェア」) のコピーを入手したすべての人物は、以下の条件に従い、本ソフトウェアを無制限に扱う権利 (使用、コピー、変更、統合、公開、配布、サブライセンス、および/または販売する権利を含みますが、これに限定されません) および本ソフトウェアの提供を受けた人物が同様の行為を行うことを許可する権利を無償で付与されます。\n\n上記の著作権表示およびこの許可通知は、ソフトウェアのすべてのコピーまたは大部分に含めるものとします。\n\n本ソフトウェアは「現状有姿」で提供され、明示的または黙示的を問わず、商品性、特定目的への適合性、非侵害性を含むがこれらに限定されない、いかなる種類の保証も付与されません。いかなる場合においても、著作者または著作権者は、契約違反、不法行為、またはその他の行為にかかわらず、本ソフトウェア、本ソフトウェアの使用、またはその他の取り扱いに起因または関連して発生するいかなる請求、損害、またはその他の責任についても責任を負わないものとします。","Japanese","ja-JP",{"_27":51,"_31":55,"_36":56},{"_29":52,"_31":53,"_33":54},"Paylocity API 엔드포인트에 대한 액세스를 제공하여 직원 데이터, 수입, 회사 코드, 지역 세금 및 급여 명세서를 검색할 수 있는 MCP 서버입니다.","mcp페이로시티","# mcpPaylocity MCP 서버\n\n[![대장간 배지](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\nPaylocity API 엔드포인트에서 데이터를 가져오는 MCP(Model Context Protocol) 서버입니다.\n\n## 구성 요소\n\n### 자원\n\n서버는 다음을 사용하여 Paylocity API 리소스를 구현합니다.\n\n* Paylocity 데이터에 액세스하기 위한 사용자 지정 `paylocity://` URI 체계\n* 다음과 같은 리소스를 이용할 수 있습니다.\n * `paylocity://employees/{company_id}` - 회사의 모든 직원을 나열합니다.\n * `paylocity://employees/{company_id}/{employee_id}` - 특정 직원에 대한 세부 정보를 가져옵니다.\n * `paylocity://earnings/{company_id}/{employee_id}` - 특정 직원의 소득 데이터 가져오기\n * `paylocity://codes/{company_id}/{code_resource}` - 특정 리소스에 대한 회사 코드를 가져옵니다.\n * `paylocity://localtaxes/{company_id}/{employee_id}` - 특정 직원의 지역 세금을 가져옵니다.\n * `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - 특정 날짜의 급여 명세서 세부 정보를 가져옵니다.\n\n### 도구\n\n서버는 다음 도구를 구현합니다.\n\n* `fetch_employees` - 회사의 모든 직원을 가져옵니다.\n * 선택적인 `company_id` 매개변수를 사용합니다.\n* `fetch_employee_details` - 특정 직원의 세부 정보를 가져옵니다.\n * 필수 `employee_id` 및 선택적 `company_id` 매개변수를 사용합니다.\n* `fetch_employee_earnings` - 특정 직원의 수입 데이터를 가져옵니다.\n * 필수 `employee_id` 및 선택적 `company_id` 매개변수를 사용합니다.\n* `fetch_company_codes` - 특정 리소스에 대한 회사 코드를 가져옵니다.\n * 필수 `code_resource` 및 선택적 `company_id` 매개변수를 사용합니다.\n* `fetch_employee_local_taxes` - 특정 직원의 지역 세금을 가져옵니다.\n * 필수 `employee_id` 및 선택적 `company_id` 매개변수를 사용합니다.\n* `fetch_employee_paystatement_details` - 특정 날짜의 급여 명세서 세부 정보를 가져옵니다.\n * 필수 `employee_id` , `year` , `check_date` 및 선택적 `company_id` 매개변수를 사용합니다.\n\n## 향후 구현\n\n다음 엔드포인트는 향후 업데이트에서 구현될 예정입니다.\n\n* \\[ ] 상위 수준의 통찰력(예: 이직률, 부서별 직원 수, 요율 비교 등)\n\n## 구성\n\n서버에는 다음 환경 변수를 설정해야 합니다.\n\n* `PAYLOCITY_CLIENT_ID` - Paylocity API 클라이언트 ID\n* `PAYLOCITY_CLIENT_SECRET` - Paylocity API 클라이언트 비밀번호\n* `PAYLOCITY_COMPANY_IDS` - 사용할 회사 ID의 쉼표로 구분된 목록\n* `PAYLOCITY_ENVIRONMENT` - 사용할 API 환경( `production` 또는 `testing` )\n\n이는 프로젝트 루트 디렉토리의 `.env` 파일에서 설정할 수 있습니다.\n\n## 보안\n\n⚠️ **중요** : 이 애플리케이션은 `src/mcppaylocity/access_token/` 디렉터리에 인증 토큰을 캐시합니다. 이 파일에는 민감한 자격 증명이 포함되어 있으므로 버전 관리에 커밋해서는 **안** 됩니다.\n\n저장소에는 이러한 경로가 `.gitignore` 에 포함되어 있지만 변경 사항을 푸시할 때 토큰 파일이 실수로 커밋되지 않도록 확인하세요.\n\n실수로 토큰 파일을 커밋한 경우 다음 단계를 따르세요.\n\n1. 저장소에서 파일을 제거합니다: `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. 제거를 커밋합니다: `git commit -m \"Remove accidentally committed token files\"`\n3. Paylocity API 자격 증명이 손상되었을 수 있으므로 해당 자격 증명을 교체하는 것을 고려하세요.\n\n## 빠른 시작\n\n### 설치하다\n\n#### 클로드 데스크탑\n\nMacOS의 경우: `~/Library/Application\\ Support/Claude/claude_desktop_config.json` Windows의 경우: `%APPDATA%/Claude/claude_desktop_config.json`\n\n지엑스피1\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n## 개발\n\n### 건축 및 출판\n\n배포를 위해 패키지를 준비하려면:\n\n1. 종속성 동기화 및 잠금 파일 업데이트:\n\n```bash\nuv sync\n```\n\n2. 패키지 배포 빌드:\n\n```bash\nuv build\n```\n\n이렇게 하면 `dist/` 디렉토리에 소스와 휠 배포판이 생성됩니다.\n\n3. PyPI에 게시:\n\n```bash\nuv publish\n```\n\n참고: 환경 변수나 명령 플래그를 통해 PyPI 자격 증명을 설정해야 합니다.\n\n* 토큰: `--token` 또는 `UV_PUBLISH_TOKEN`\n* 또는 사용자 이름/비밀번호: `--username` / `UV_PUBLISH_USERNAME` 및 `--password` / `UV_PUBLISH_PASSWORD`\n\n### 디버깅\n\nMCP 서버는 stdio를 통해 실행되므로 디버깅이 어려울 수 있습니다. 최상의 디버깅 환경을 위해서는 [MCP Inspector](https://github.com/modelcontextprotocol/inspector) 사용을 강력히 권장합니다.\n\n다음 명령을 사용하여 [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) 통해 MCP Inspector를 시작할 수 있습니다.\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity\n```\n\nInspector를 실행하면 브라우저에서 접근하여 디버깅을 시작할 수 있는 URL이 표시됩니다.\n\n## 건축학\n\n서버는 다음 구성 요소로 구축되었습니다.\n\n1. **PaylocityClient** - Paylocity API와의 통신을 처리합니다.\n2. **TokenManager** - 캐싱 및 갱신을 포함한 인증 토큰을 관리합니다.\n3. **FastMCP 서버** - MCP 리소스 및 도구를 통해 Paylocity 데이터를 노출합니다.\n\n## 특허\n\nMIT 라이센스\n\n저작권 (c) 2024 MJ Zou ( [@mjzou](https://www.linkedin.com/in/mjzou/) )\n\n본 소프트웨어 및 관련 문서 파일(이하 \"소프트웨어\")의 사본을 취득한 모든 사람에게 소프트웨어를 제한 없이 거래할 수 있는 권한을 무상으로 부여합니다. 여기에는 소프트웨어 사본을 사용, 복사, 수정, 병합, 게시, 배포, 하위 라이선스 및/또는 판매할 수 있는 권한이 포함되나 이에 국한되지 않으며, 소프트웨어가 제공된 사람에게도 이러한 권한을 부여합니다. 단, 다음 조건에 따라야 합니다.\n\n위의 저작권 고지와 본 허가 고지는 소프트웨어의 모든 사본 또는 실질적인 부분에 포함되어야 합니다.\n\n본 소프트웨어는 상품성, 특정 목적 적합성 및 비침해에 대한 보증을 포함하되 이에 국한되지 않는 명시적 또는 묵시적 보증 없이 \"있는 그대로\" 제공됩니다. 어떠한 경우에도 저작자 또는 저작권자는 본 소프트웨어 또는 본 소프트웨어의 사용 또는 기타 거래와 관련하여 발생하는 계약, 불법 행위 또는 기타 소송을 포함한 모든 청구, 손해 또는 기타 책임에 대해 책임을 지지 않습니다.","Korean","ko-KR",{"_27":58,"_31":61,"_36":62},{"_29":59,"_31":32,"_33":60},"MCP 服务器提供对 Paylocity API 端点的访问，允许检索员工数据、收入、公司代码、地方税和工资单。","# mcpPaylocity MCP 服务器\n\n[![铁匠徽章](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\n模型上下文协议 (MCP) 服务器从 Paylocity API 端点获取数据。\n\n## 成分\n\n### 资源\n\n服务器通过以下方式实现 Paylocity API 资源：\n\n* 用于访问 Paylocity 数据的自定义`paylocity://` URI 方案\n* 可用的资源如下：\n * `paylocity://employees/{company_id}` - 列出公司的所有员工\n * `paylocity://employees/{company_id}/{employee_id}` - 获取特定员工的详细信息\n * `paylocity://earnings/{company_id}/{employee_id}` - 获取特定员工的收入数据\n * `paylocity://codes/{company_id}/{code_resource}` - 获取特定资源的公司代码\n * `paylocity://localtaxes/{company_id}/{employee_id}` - 获取特定员工的当地税费\n * `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - 获取特定日期的工资单详情\n\n### 工具\n\n该服务器实现了以下工具：\n\n* `fetch_employees` - 获取公司的所有员工\n * 采用可选的`company_id`参数\n* `fetch_employee_details` - 获取特定员工的详细信息\n * 采用必需的`employee_id`和可选的`company_id`参数\n* `fetch_employee_earnings` - 获取特定员工的收入数据\n * 采用必需的`employee_id`和可选的`company_id`参数\n* `fetch_company_codes` - 获取特定资源的公司代码\n * 采用必需的`code_resource`和可选的`company_id`参数\n* `fetch_employee_local_taxes` - 获取特定员工的当地税费\n * 采用必需的`employee_id`和可选的`company_id`参数\n* `fetch_employee_paystatement_details` - 获取特定日期的工资单详细信息\n * 需要`employee_id` 、 `year` 、 `check_date`和可选`company_id`参数\n\n## 未来实施\n\n以下端点将在未来的更新中实现：\n\n* \\[ ] 更高层次的洞察（例如离职率、部门员工人数、费率比较等）\n\n## 配置\n\n服务器需要设置以下环境变量：\n\n* `PAYLOCITY_CLIENT_ID` - 您的 Paylocity API 客户端 ID\n* `PAYLOCITY_CLIENT_SECRET` - 您的 Paylocity API 客户端密钥\n* `PAYLOCITY_COMPANY_IDS` - 要使用的公司 ID 的逗号分隔列表\n* `PAYLOCITY_ENVIRONMENT` - 要使用的 API 环境（ `production`或`testing` ）\n\n这些可以在项目根目录中的`.env`文件中设置。\n\n## 安全\n\n⚠️**重要提示**：本应用将身份验证令牌缓存在`src/mcppaylocity/access_token/`目录中。这些文件包含敏感凭证，**请勿**提交至版本控制。\n\n存储库在`.gitignore`中包含这些路径，但请验证在推送更改时不会意外提交令牌文件。\n\n如果您意外提交了令牌文件，请按照以下步骤操作：\n\n1. 从存储库中删除文件： `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. 提交删除： `git commit -m \"Remove accidentally committed token files\"`\n3. 考虑更换您的 Paylocity API 凭证，因为它们可能已被泄露\n\n## 快速入门\n\n### 安装\n\n#### 克劳德桌面\n\n在 MacOS 上： `~/Library/Application\\ Support/Claude/claude_desktop_config.json`在 Windows 上： `%APPDATA%/Claude/claude_desktop_config.json`\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcpPaylocity\",\n \"run\",\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n```json\n\"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n}\n```\n\n## 发展\n\n### 构建和发布\n\n准备分发包：\n\n1. 同步依赖项并更新锁文件：\n\n```bash\nuv sync\n```\n\n2. 构建软件包分发版：\n\n```bash\nuv build\n```\n\n这将在`dist/`目录中创建源和轮子分布。\n\n3. 发布到 PyPI：\n\n```bash\nuv publish\n```\n\n注意：您需要通过环境变量或命令标志设置 PyPI 凭据：\n\n* 令牌： `--token`或`UV_PUBLISH_TOKEN`\n* 或用户名/密码： `--username` / `UV_PUBLISH_USERNAME`和`--password` / `UV_PUBLISH_PASSWORD`\n\n### 调试\n\n由于 MCP 服务器通过 stdio 运行，调试起来可能比较困难。为了获得最佳调试体验，我们强烈建议使用[MCP Inspector](https://github.com/modelcontextprotocol/inspector) 。\n\n您可以使用以下命令通过[`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)启动 MCP Inspector：\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcpPaylocity run mcppaylocity\n```\n\n启动后，检查器将显示一个 URL，您可以在浏览器中访问该 URL 以开始调试。\n\n## 建筑学\n\n该服务器由以下组件构建：\n\n1. **PaylocityClient** - 处理与 Paylocity API 的通信\n2. **TokenManager** - 管理身份验证令牌，包括缓存和更新\n3. **FastMCP 服务器**- 通过 MCP 资源和工具公开 Paylocity 数据\n\n## 执照\n\nMIT 许可证\n\n版权所有 (c) 2024 MJ 邹 ( [@mjzou](https://www.linkedin.com/in/mjzou/) )\n\n特此授予获得此软件和相关文档文件（“软件”）副本的任何人免费许可，以无限制方式处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再授权和/或销售软件副本的权利，并允许向其提供软件的人员这样做，但须遵守以下条件：\n\n上述版权声明和本许可声明均应包含在软件的所有副本或实质性部分中。\n\n本软件按“原样”提供，不附带任何形式的明示或暗示保证，包括但不限于适销性、适用于特定用途和非侵权性的保证。在任何情况下，作者或版权所有者均不对因本软件或使用或以其他方式处理本软件而引起的或与之相关的任何索赔、损害或其他责任承担责任，无论是合同、侵权或其他诉讼。","Chinese","zh-CN","githubUser","locale",{"_66":67,"_13":68,"_78":30,"_79":30,"_16":80,"_81":82,"_31":32,"_115":116,"_123":-5,"_124":-5,"_125":126,"_178":179,"_184":-5,"_89":32,"_185":186,"_92":187,"_188":189},"addedAt","2025-03-21T10:46:01.691130Z",[69,70,71,72,73,74,75,76,77],"category:databases","category:erp-systems","category:developer-tools","environment:network","hosting:remote-capable","language:python","security_grade:a","quality_grade:a","author:claimed","descriptionMarkdown","descriptionPlainText",2219,"integrations",[83,94,101,108],{"_84":85,"_29":91,"_92":93},"brand",{"_86":87,"_31":88,"_89":90},"logoSvgPath","M24 0v24H0V0h24ZM10.933 15.89H6.84v5.52h4.198v-.93H7.955v-1.503h2.77v-.93h-2.77v-1.224h2.978v-.934Zm2.146 0h-1.084v5.52h1.035v-3.6l2.226 3.6h1.118v-5.52h-1.036v3.686l-2.259-3.687Zm5.117 0h-1.208l1.973 5.52h1.19l1.976-5.52h-1.182l-1.352 4.085-1.397-4.086ZM5.4 19.68H3.72v1.68H5.4v-1.68Z",".ENV","slug","dotenv","Allows loading configuration variables from a .env file to connect to the Paylocity API, supporting secure credential management.","uid","xesadjln0e",{"_84":95,"_29":99,"_92":100},{"_86":96,"_31":97,"_89":98},"M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12","GitHub","github","Mentions GitHub in the context of security and avoiding accidental credential commits in version control.","regrt1sjir",{"_84":102,"_29":106,"_92":107},{"_86":103,"_31":104,"_89":105},"M0 14.727h.941v-2.453c0-.484.318-.835.771-.835.439 0 .71.276.71.722v2.566h.915V12.25c0-.48.31-.812.764-.812.46 0 .718.28.718.77v2.518h.94v-2.748c0-.801-.517-1.334-1.307-1.334-.578 0-1.054.31-1.247.805h-.023c-.147-.514-.552-.805-1.118-.805-.545 0-.968.306-1.142.771H.903v-.695H0v4.006zm7.82-.646c-.408 0-.68-.208-.68-.537 0-.318.26-.522.714-.552l.926-.057v.307c0 .483-.427.839-.96.839zm-.284.71c.514 0 1.017-.268 1.248-.703h.018v.639h.908v-2.76c0-.804-.647-1.33-1.64-1.33-1.021 0-1.66.537-1.701 1.285h.873c.06-.332.344-.548.79-.548.464 0 .748.242.748.662v.287l-1.058.06c-.976.061-1.524.488-1.524 1.199 0 .721.564 1.209 1.338 1.209zm6.305-2.642c-.065-.843-.719-1.512-1.777-1.512-1.164 0-1.92.805-1.92 2.087 0 1.3.756 2.082 1.928 2.082 1.005 0 1.697-.59 1.772-1.485h-.888c-.087.453-.397.725-.873.725-.597 0-.982-.483-.982-1.322 0-.824.381-1.323.975-1.323.502 0 .8.321.876.748h.889zm2.906-2.967c-1.591 0-2.589 1.085-2.589 2.82 0 1.735.998 2.816 2.59 2.816 1.586 0 2.584-1.081 2.584-2.816 0-1.735-.997-2.82-2.585-2.82zm0 .832c.971 0 1.591.77 1.591 1.988 0 1.213-.62 1.984-1.59 1.984-.976 0-1.592-.77-1.592-1.984 0-1.217.616-1.988 1.591-1.988zm2.982 3.178c.042 1.006.866 1.626 2.12 1.626 1.32 0 2.151-.65 2.151-1.686 0-.813-.469-1.27-1.576-1.523l-.627-.144c-.67-.158-.945-.37-.945-.733 0-.453.415-.756 1.032-.756.623 0 1.05.306 1.096.817h.93c-.023-.96-.817-1.61-2.019-1.61-1.187 0-2.03.653-2.03 1.62 0 .78.477 1.263 1.482 1.494l.707.166c.688.163.967.39.967.782 0 .454-.457.779-1.115.779-.665 0-1.167-.329-1.228-.832h-.945z","macOS","macos","Provides specific installation path instructions for Claude Desktop on macOS systems.","9sp3ttovkw",{"_84":109,"_29":113,"_92":114},{"_86":110,"_31":111,"_89":112},"M23.922 13.58v3.912L20.55 18.72l-.078.055.052.037 3.45-1.256.026-.036v-3.997l-.053-.036-.025.092z M23.621 5.618l-3.04 1.107v3.912l3.339-1.215V5.509zM23.92 13.457V9.544l-3.336 1.215v3.913zM20.47 14.71V10.8L17.17 12v3.913zM17.034 19.996v-3.912l-3.313 1.206v3.912zM17.17 16.057v3.868l3.314-1.206V14.85l-3.314 1.206zm2.093 1.882c-.367.134-.663-.074-.663-.463s.296-.814.663-.947c.365-.133.662.075.662.464s-.297.814-.662.946z M13.225 9.315l.365-.132-3.285-1.197-3.323 1.21.102.037 3.184 1.16zM20.507 10.664V6.751L17.17 7.965v3.913zM17.058 11.918V8.005l-3.302 1.202v3.912zM13.643 9.246l-3.336 1.215v3.913l3.336-1.215zM6.907 13.165l3.322 1.209v-3.913L6.907 9.252z M10.34 7.873l3.281 1.193V5.198l-3.28-1.193zM20.507 2.715L17.19 3.922v3.913l3.317-1.207zM16.95 3.903L13.724 2.73l-3.269 1.19 3.225 1.174zM15.365 4.606l-1.624.592v3.868l3.317-1.207V3.991l-1.693.615zm-.391 2.778c-.367.134-.662-.074-.662-.464s.295-.813.662-.946c.366-.133.663.074.663.464s-.297.813-.663.946z M10.229 18.41v-3.914l-3.322-1.209V17.2zM13.678 17.182v-3.913l-3.371 1.227v3.913z M13.756 17.154l3.3-1.2V12.04l-3.3 1.2zM13.678 21.217l-3.371 1.227v-3.912h-.078v3.912l-3.322-1.209v-3.913l-.053-.058-.025-.06-3.336-1.21v-3.948l.034.013 3.287 1.196.015-.078-3.261-1.187 3.26-1.187v-.109L3.876 9.62l-.307-.112 3.26-1.188v.877l.079-.055V6.769l3.257 1.185.058-.061L7.084 6.75l-.102-.037 3.24-1.179v-.083L6.854 6.677v.018l-.025.018v1.523L3.44 9.47v.02l-.025.017v4.007l-3.39 1.233v.019L0 14.784v3.995l.025.037 3.4 1.237.008-.006.007.01 3.4 1.238.008-.006.006.01 3.4 1.237.014-.009.012.01 3.45-1.256.026-.037-.078-.027zM3.493 9.563l3.257 1.185-3.257 1.187V9.562zM3.4 19.96L.078 18.752v-3.913l2.361.86.96.349v3.913zm.015-3.99L.335 14.85l-.182-.066 3.262-1.187v2.374zm3.399 5.231l-3.321-1.209v-3.912l3.321 1.209v3.912zM23.791 5.434l-3.21-1.17v2.338zM20.387 2.643l-3.24-1.18-3.27 1.19 3.247 1.182z","PyPI","pypi","Supports publishing the MCP server package to PyPI for distribution and installation.","huk8l159cq","namespace",{"_117":118,"_89":122},"owner",{"_119":120},"githubAccount",{"_121":122},"login","mz462","readmeMarkdown","redditPostExternalId","repository",{"_127":128,"_148":149,"_153":154,"_170":-5,"_171":172,"_173":-5,"_174":175},"argumentsJsonSchema",{"_129":130,"_145":146,"_134":147},"properties",{"_131":132,"_136":137,"_139":140,"_142":143},"PAYLOCITY_CLIENT_ID",{"_29":133,"_134":135},"Your Paylocity API client ID","type","string","PAYLOCITY_COMPANY_IDS",{"_29":138,"_134":135},"Comma-separated list of company IDs to use","PAYLOCITY_ENVIRONMENT",{"_29":141,"_134":135},"API environment to use ('production' or 'testing')","PAYLOCITY_CLIENT_SECRET",{"_29":144,"_134":135},"Your Paylocity API client secret","required",[131,142,136,139],"object","githubProject",{"_33":150,"_151":152},"# mcpPaylocity MCP Server\n[![smithery badge](https://smithery.ai/badge/@mz462/mcppaylocity)](https://smithery.ai/server/@mz462/mcppaylocity)\n\nA Model Context Protocol (MCP) server to fetch data from Paylocity API endpoints.\n\n## Components\n\n### Resources\n\nThe server implements Paylocity API resources with:\n- Custom `paylocity://` URI scheme for accessing Paylocity data\n- The following resources are available:\n - `paylocity://employees/{company_id}` - List all employees for a company\n - `paylocity://employees/{company_id}/{employee_id}` - Get details for a specific employee\n - `paylocity://earnings/{company_id}/{employee_id}` - Get earnings data for a specific employee\n - `paylocity://codes/{company_id}/{code_resource}` - Get company codes for a specific resource\n - `paylocity://localtaxes/{company_id}/{employee_id}` - Get local taxes for a specific employee\n - `paylocity://paystatement/{company_id}/{employee_id}/{year}/{check_date}` - Get pay statement details for a specific date\n\n### Tools\n\nThe server implements the following tools:\n- `fetch_employees` - Fetches all employees for a company\n - Takes optional `company_id` parameter\n- `fetch_employee_details` - Fetches details for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_employee_earnings` - Fetches earnings data for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_company_codes` - Fetches company codes for a specific resource\n - Takes required `code_resource` and optional `company_id` parameters\n- `fetch_employee_local_taxes` - Fetches local taxes for a specific employee\n - Takes required `employee_id` and optional `company_id` parameters\n- `fetch_employee_paystatement_details` - Fetches pay statement details for a specific date\n - Takes required `employee_id`, `year`, `check_date` and optional `company_id` parameters\n\n## Future Implementations\n\nThe following endpoints will be implemented in future updates:\n\n- [ ] Higher level insights (e.g. turnover rate, headcount by department, rate comparison etc.)\n\n## Configuration\n\nThe server requires the following environment variables to be set:\n- `PAYLOCITY_CLIENT_ID` - Your Paylocity API client ID\n- `PAYLOCITY_CLIENT_SECRET` - Your Paylocity API client secret\n- `PAYLOCITY_COMPANY_IDS` - Comma-separated list of company IDs to use\n- `PAYLOCITY_ENVIRONMENT` - API environment to use (`production` or `testing`)\n- `MODEL_COST_PRIORITY` - Optional cost priority for model selection\n- `MODEL_SPEED_PRIORITY` - Optional speed priority for model selection\n- `MODEL_INTELLIGENCE_PRIORITY` - Optional intelligence priority for model selection\n- `MODEL_HINTS` - Optional comma-separated model name hints\n\nThese can be set in a `.env` file in the project root directory.\n\n### MCP Handshake\n\nOn startup the server responds to the MCP `initialize` request with handshake data\ncontaining its capabilities, instructions, protocol version and server info. The\ninstructions field describes how to use the Paylocity resources and tools.\n\n## Security\n\n⚠️ **IMPORTANT**: This application caches authentication tokens in the `src/mcppaylocity/access_token/` directory. These files contain sensitive credentials and should **never** be committed to version control.\n\nThe repository includes these paths in `.gitignore`, but please verify that token files are not accidentally committed when pushing changes.\n\nIf you've accidentally committed token files, follow these steps:\n1. Remove the files from the repository: `git rm --cached src/mcppaylocity/access_token/token.json src/mcppaylocity/access_token/token_info.txt`\n2. Commit the removal: `git commit -m \"Remove accidentally committed token files\"`\n3. Consider rotating your Paylocity API credentials as they may have been compromised\n\n## Quickstart\n\n### Install\n\n#### Claude Desktop\n\nOn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json`\nOn Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n

Development/Unpublished Servers Configuration

\n \n ```json\n \"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"/path/to/mcpPaylocity\",\n \"run\",\n \"mcppaylocity\"\n ]\n }\n }\n ```\n

\n\n

Published Servers Configuration

\n \n ```json\n \"mcpServers\": {\n \"mcpPaylocity\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcppaylocity\"\n ]\n }\n }\n ```\n

MCP directory API