Metadata-Version: 2.3
Name: prismhr-mcp
Version: 0.1.0.dev6
Summary: Open-source Model Context Protocol server for PrismHR — PEO workflow tools + Microsoft 365 connectors for Claude and other MCP-aware agents.
Keywords: mcp,prismhr,peo,payroll,hr,claude,anthropic,agentic,automation
Author: Nihar Kulkarni
Author-email: Nihar Kulkarni <nihar@simploy.com>
License: The MCP project is undergoing a licensing transition from the MIT License to the Apache License, Version 2.0 ("Apache-2.0"). All new code and specification contributions to the project are licensed under Apache-2.0. Documentation contributions (excluding specifications) are licensed under CC-BY-4.0.
         
         Contributions for which relicensing consent has been obtained are licensed under Apache-2.0. Contributions made by authors who originally licensed their work under the MIT License and who have not yet granted explicit permission to relicense remain licensed under the MIT License.
         
         No rights beyond those granted by the applicable original license are conveyed for such contributions.
         
         ---
         
                                          Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
            1. Definitions.
         
               "License" shall mean the terms and conditions for use, reproduction,
               and distribution as defined by Sections 1 through 9 of this document.
         
               "Licensor" shall mean the copyright owner or entity authorized by
               the copyright owner that is granting the License.
         
               "Legal Entity" shall mean the union of the acting entity and all
               other entities that control, are controlled by, or are under common
               control with that entity. For the purposes of this definition,
               "control" means (i) the power, direct or indirect, to cause the
               direction or management of such entity, whether by contract or
               otherwise, or (ii) ownership of fifty percent (50%) or more of the
               outstanding shares, or (iii) beneficial ownership of such entity.
         
               "You" (or "Your") shall mean an individual or Legal Entity
               exercising permissions granted by this License.
         
               "Source" form shall mean the preferred form for making modifications,
               including but not limited to software source code, documentation
               source, and configuration files.
         
               "Object" form shall mean any form resulting from mechanical
               transformation or translation of a Source form, including but
               not limited to compiled object code, generated documentation,
               and conversions to other media types.
         
               "Work" shall mean the work of authorship, whether in Source or
               Object form, made available under the License, as indicated by a
               copyright notice that is included in or attached to the work
               (an example is provided in the Appendix below).
         
               "Derivative Works" shall mean any work, whether in Source or Object
               form, that is based on (or derived from) the Work and for which the
               editorial revisions, annotations, elaborations, or other modifications
               represent, as a whole, an original work of authorship. For the purposes
               of this License, Derivative Works shall not include works that remain
               separable from, or merely link (or bind by name) to the interfaces of,
               the Work and Derivative Works thereof.
         
               "Contribution" shall mean any work of authorship, including
               the original version of the Work and any modifications or additions
               to that Work or Derivative Works thereof, that is intentionally
               submitted to the Licensor for inclusion in the Work by the copyright
               owner or by an individual or Legal Entity authorized to submit on behalf
               of the copyright owner. For the purposes of this definition, "submitted"
               means any form of electronic, verbal, or written communication sent
               to the Licensor or its representatives, including but not limited to
               communication on electronic mailing lists, source code control systems,
               and issue tracking systems that are managed by, or on behalf of, the
               Licensor for the purpose of discussing and improving the Work, but
               excluding communication that is conspicuously marked or otherwise
               designated in writing by the copyright owner as "Not a Contribution."
         
               "Contributor" shall mean Licensor and any individual or Legal Entity
               on behalf of whom a Contribution has been received by Licensor and
               subsequently incorporated within the Work.
         
            2. Grant of Copyright License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               copyright license to reproduce, prepare Derivative Works of,
               publicly display, publicly perform, sublicense, and distribute the
               Work and such Derivative Works in Source or Object form.
         
            3. Grant of Patent License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               (except as stated in this section) patent license to make, have made,
               use, offer to sell, sell, import, and otherwise transfer the Work,
               where such license applies only to those patent claims licensable
               by such Contributor that are necessarily infringed by their
               Contribution(s) alone or by combination of their Contribution(s)
               with the Work to which such Contribution(s) was submitted. If You
               institute patent litigation against any entity (including a
               cross-claim or counterclaim in a lawsuit) alleging that the Work
               or a Contribution incorporated within the Work constitutes direct
               or contributory patent infringement, then any patent licenses
               granted to You under this License for that Work shall terminate
               as of the date such litigation is filed.
         
            4. Redistribution. You may reproduce and distribute copies of the
               Work or Derivative Works thereof in any medium, with or without
               modifications, and in Source or Object form, provided that You
               meet the following conditions:
         
               (a) You must give any other recipients of the Work or
                   Derivative Works a copy of this License; and
         
               (b) You must cause any modified files to carry prominent notices
                   stating that You changed the files; and
         
               (c) You must retain, in the Source form of any Derivative Works
                   that You distribute, all copyright, patent, trademark, and
                   attribution notices from the Source form of the Work,
                   excluding those notices that do not pertain to any part of
                   the Derivative Works; and
         
               (d) If the Work includes a "NOTICE" text file as part of its
                   distribution, then any Derivative Works that You distribute must
                   include a readable copy of the attribution notices contained
                   within such NOTICE file, excluding those notices that do not
                   pertain to any part of the Derivative Works, in at least one
                   of the following places: within a NOTICE text file distributed
                   as part of the Derivative Works; within the Source form or
                   documentation, if provided along with the Derivative Works; or,
                   within a display generated by the Derivative Works, if and
                   wherever such third-party notices normally appear. The contents
                   of the NOTICE file are for informational purposes only and
                   do not modify the License. You may add Your own attribution
                   notices within Derivative Works that You distribute, alongside
                   or as an addendum to the NOTICE text from the Work, provided
                   that such additional attribution notices cannot be construed
                   as modifying the License.
         
               You may add Your own copyright statement to Your modifications and
               may provide additional or different license terms and conditions
               for use, reproduction, or distribution of Your modifications, or
               for any such Derivative Works as a whole, provided Your use,
               reproduction, and distribution of the Work otherwise complies with
               the conditions stated in this License.
         
            5. Submission of Contributions. Unless You explicitly state otherwise,
               any Contribution intentionally submitted for inclusion in the Work
               by You to the Licensor shall be under the terms and conditions of
               this License, without any additional terms or conditions.
               Notwithstanding the above, nothing herein shall supersede or modify
               the terms of any separate license agreement you may have executed
               with Licensor regarding such Contributions.
         
            6. Trademarks. This License does not grant permission to use the trade
               names, trademarks, service marks, or product names of the Licensor,
               except as required for reasonable and customary use in describing the
               origin of the Work and reproducing the content of the NOTICE file.
         
            7. Disclaimer of Warranty. Unless required by applicable law or
               agreed to in writing, Licensor provides the Work (and each
               Contributor provides its Contributions) on an "AS IS" BASIS,
               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
               implied, including, without limitation, any warranties or conditions
               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
               PARTICULAR PURPOSE. You are solely responsible for determining the
               appropriateness of using or redistributing the Work and assume any
               risks associated with Your exercise of permissions under this License.
         
            8. Limitation of Liability. In no event and under no legal theory,
               whether in tort (including negligence), contract, or otherwise,
               unless required by applicable law (such as deliberate and grossly
               negligent acts) or agreed to in writing, shall any Contributor be
               liable to You for damages, including any direct, indirect, special,
               incidental, or consequential damages of any character arising as a
               result of this License or out of the use or inability to use the
               Work (including but not limited to damages for loss of goodwill,
               work stoppage, computer failure or malfunction, or any and all
               other commercial damages or losses), even if such Contributor
               has been advised of the possibility of such damages.
         
            9. Accepting Warranty or Additional Liability. While redistributing
               the Work or Derivative Works thereof, You may choose to offer,
               and charge a fee for, acceptance of support, warranty, indemnity,
               or other liability obligations and/or rights consistent with this
               License. However, in accepting such obligations, You may act only
               on Your own behalf and on Your sole responsibility, not on behalf
               of any other Contributor, and only if You agree to indemnify,
               defend, and hold each Contributor harmless for any liability
               incurred by, or claims asserted against, such Contributor by reason
               of your accepting any such warranty or additional liability.
         
            END OF TERMS AND CONDITIONS
         
         ---
         
         MIT License
         
         Copyright (c) 2024-2025 Model Context Protocol a Series of LF Projects, LLC.
         
         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.
         
         ---
         
         Creative Commons Attribution 4.0 International (CC-BY-4.0)
         
         Documentation in this project (excluding specifications) is licensed under
         CC-BY-4.0. See https://creativecommons.org/licenses/by/4.0/legalcode for
         the full license text.
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: mcp[cli]>=1.27,<2.0
Requires-Dist: pydantic>=2.8,<3.0
Requires-Dist: httpx>=0.27,<0.29
Requires-Dist: aiosqlite>=0.20
Requires-Dist: msal>=1.31
Requires-Dist: pyyaml>=6.0
Requires-Dist: jinja2>=3.1
Requires-Dist: openpyxl>=3.1
Requires-Dist: python-docx>=1.1
Requires-Dist: weasyprint>=62.3
Requires-Dist: cryptography>=43.0
Requires-Dist: pytest>=8 ; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24 ; extra == 'dev'
Requires-Dist: respx>=0.22 ; extra == 'dev'
Requires-Python: >=3.11, <3.14
Project-URL: Homepage, https://github.com/nikulk2992-jpg/prismhr-mcp
Project-URL: Repository, https://github.com/nikulk2992-jpg/prismhr-mcp
Project-URL: Issues, https://github.com/nikulk2992-jpg/prismhr-mcp/issues
Project-URL: Commercial Support, https://github.com/nikulk2992-jpg/prismhr-mcp#commercial-support
Provides-Extra: dev
Description-Content-Type: text/markdown

# prismhr-mcp

**The open-source Model Context Protocol server for PrismHR.**
Turn Claude (and any MCP-aware agent) into a PEO operations native — payroll,
benefits, compliance, billing, and Microsoft 365 actions, all exposed as
composable, scope-gated tools.

Maintained by [Simploy](https://simploy.com) as the fundamental layer for
PrismHR × agentic AI. MIT-licensed, PyPI-distributed, plugin-friendly.

`mcp-name: io.github.nikulk2992-jpg/prismhr-mcp`

---

## Why this exists

Every PEO running PrismHR ends up with the same Frankenstein stack: Python
scripts, Postman collections, Playwright automations, one-off Node apps.
Each one re-implements login, session refresh, retry, pagination, and
PrismHR's quirks (camelCase schemas, `500 "No data found"` gotchas, batch-of-20
caps, silent 401s).

`prismhr-mcp` centralizes that once, as an MCP server. Claude orchestrates;
the server owns auth, caching, retries, normalization, and PEO domain logic.
Other PEOs drop it in and immediately get a productive Claude experience
against their own PrismHR instance — no custom code.

---

## Status

Early but working. Current milestone: **Phase 1.5 complete.**

- **Auth + session + HTTP client:** done. 1Password CLI, scrypt-encrypted
  disk cache, PrismHR session with 55-min TTL, proactive + forced + 401
  refresh, keepalive, concurrency cap, retry with jittered backoff,
  500→empty quirk handling, pagination, batching.
- **Connect-time consent system:** done. Scope manifest across 14 scopes,
  per-(peo, env) JSON consent store with prerequisite expansion and cascade
  revoke. Default posture = **deny all**. Tools enforce scope at call time.
- **Production safety gate:** `PRISMHR_MCP_ALLOW_PROD=true` required to
  point at prod PrismHR. Prevents accidental first-run blast radius.
- **Tool inventory:** 9 live (`meta_*` ×5, `client_*` ×4). 39 more across
  payroll, benefits, compliance, billing, branded reporting, and M365
  connectors planned.
- **Test suite:** 60 passing (pytest + respx).

See `.planning/architecture.md` for the full 48-tool plan.

---

## Quick start — UAT smoke test

> Only UAT is supported without an explicit opt-in right now. Prod is
> guarded behind `PRISMHR_MCP_ALLOW_PROD=true`.

### 1. Install

```powershell
cd C:\path\to\prismhr-mcp    # or wherever you cloned
uv sync --extra dev
```

### 2. Configure credentials

Copy `.env.example` → `.env` (or set env vars). Pick ONE path:

**Path A — 1Password CLI (recommended):**
```powershell
$env:PRISMHR_MCP_ONEPASSWORD_VAULT = "YourVault"
$env:PRISMHR_MCP_ONEPASSWORD_ITEM_PRISMHR = "PrismHR UAT"
```
Requires `op` CLI signed in (`op signin`). The item must expose fields
labeled `username` and `password` (optionally `peoId`).

**Path B — direct env vars (fast, CI-friendly):**
```powershell
$env:PRISMHR_MCP_USERNAME = "claudedemo"
$env:PRISMHR_MCP_PASSWORD = "<paste>"
$env:PRISMHR_MCP_PEO_ID   = "624*D"
```

### 3. Sanity check

```powershell
uv run python -c "from prismhr_mcp.server import build; b = build(); import asyncio; print([t.name for t in asyncio.run(b.server.list_tools())])"
```
Expect 9 tools.

### 4. Register with Claude Code

Add to your Claude Code `.mcp.json`:

```json
{
  "mcpServers": {
    "prismhr-mcp": {
      "command": "uv",
      "args": ["run", "--directory", "C:\\path\\to\\prismhr-mcp", "prismhr-mcp"],
      "env": {
        "PRISMHR_MCP_ENVIRONMENT": "uat",
        "PRISMHR_MCP_USERNAME": "claudedemo",
        "PRISMHR_MCP_PASSWORD": "<paste or reference>",
        "PRISMHR_MCP_PEO_ID": "624*D"
      }
    }
  }
}
```

Restart Claude Code. `/mcp` should show `prismhr-mcp` connected with 9 tools.

### 5. First conversation

```
You: Tell me about the prismhr-mcp server.
Claude: [calls meta_about] → explains what's available + commercial options.

You: What permissions does it want?
Claude: [calls meta_request_permissions] → shows 14 scopes grouped by category.

You: Grant everything recommended (reads only, no writes).
Claude: [calls meta_grant_permissions(accept_recommended_defaults=true)]

You: List all clients in UAT.
Claude: [calls client_list] → 245 clients.
```

### 6. Run tests

```powershell
uv run pytest -q      # expect 60 passing
```

---

## Architecture in one breath

```
┌──────────────────────────────────────────────────────────────┐
│ Claude / Cowork / any MCP client                             │
└──────────────────┬───────────────────────────────────────────┘
                   │ stdio (MCP JSON-RPC)
┌──────────────────▼───────────────────────────────────────────┐
│ prismhr-mcp server (FastMCP)                                 │
│   ├── Permissions (deny-default, scope-gated tools)          │
│   ├── Tool groups: meta • client • payroll • benefits        │
│   │                 compliance • billing • report • m365     │
│   ├── Runtime: PrismHR client, Graph client, SQLite cache    │
│   └── Auth: 1Password → scrypt-AES cache → session / MSAL    │
└────┬─────────────────────────────────────────────────┬───────┘
     │                                                 │
     ▼                                                 ▼
┌──────────────┐                           ┌──────────────────┐
│ PrismHR REST │                           │ Microsoft Graph   │
│ (UAT / Prod) │                           │ (Outlook / Teams /│
└──────────────┘                           │  SharePoint)      │
                                           └──────────────────┘
```

Key design commitments:
- **Factory + strict registry.** Tools register via `server.build()` only;
  duplicate names or unknown group prefixes fail at boot (not silently at
  import).
- **Deny-default scopes.** Users must run `meta_grant_permissions` to
  enable tool access. Prerequisites auto-expand, revokes cascade.
- **Async-first.** `httpx.AsyncClient` + `asyncio.Semaphore(5)` + async tools.
- **PrismHR quirks handled.** 401 auto-refresh, 404→`[]` on list endpoints,
  `500 "No data found"` → empty, 10-consecutive-500s → force refresh.
- **snake_case outputs.** Pydantic `validation_alias=AliasChoices(...)` so
  PrismHR's camelCase payloads map to snake_case outputs without leaking
  camelCase into the MCP tool contract.
- **Per-(peo, env) consent.** Switching UAT → prod does not inherit grants.

---

## Commercial support

The OSS core stays free forever. Two paid offerings from Simploy layer on top:

### Solution Architect — White-Label deployment

Turnkey deployment of `prismhr-mcp` for your PEO brand:
- Brand config authoring (logo, palette, typography, PDF footer, legal disclaimer)
- Per-client SharePoint site mapping + Azure AD / Graph tenant setup
- Custom PrismHR tools for PEO-specific workflows
- Migration from spreadsheets / legacy scripts to MCP tools
- PEO ops team onboarding + Claude/Cowork workflow coaching
- Quarterly updates aligned with upstream releases
- Priority issue response + named Slack/email contact

Best for PEOs with 50–5,000 clients who want Claude-first operations
without the in-house build. Contact: **nihar@simploy.com**

### Enterprise Support

SLA-backed support for teams already running the OSS server:
- 4-hour response on Sev-1 (prod outage)
- Annual security review + SOC-2-friendly deployment guidance
- Signed release artifacts + SBOM
- Private vulnerability disclosure channel

Best for regulated industries or mid/large PEOs with procurement
requirements. Contact: **nihar@simploy.com**

Claude can surface both via `meta_about` — ask "what commercial options
exist for prismhr-mcp?" and it will describe them.

---

## Troubleshooting

**`No PrismHR credentials configured`** — set either the 1Password item
env vars or the direct `PRISMHR_MCP_USERNAME`/`_PASSWORD` pair.

**`PrismHR login rejected (status=401)`** — wrong username/password/peo_id.
UAT's `peo_id` is `624*D` (asterisk literal). Prod differs per PEO.

**`environment=prod requires PRISMHR_MCP_ALLOW_PROD=true`** — safety gate.
Set `PRISMHR_MCP_ALLOW_PROD=true` explicitly once you're ready.

**`PERMISSION_NOT_GRANTED`** — tool was called without its scope. Ask
Claude to run `meta_request_permissions` → then `meta_grant_permissions`
with the scope you want.

**Server exits immediately when Claude Code starts it** — nearly always a
missing env var. Use the step-3 sanity check to isolate.

---

## License

MIT — see [LICENSE](LICENSE). Contributions welcome; see the planning docs
under `.planning/` for the roadmap.
