How do I find my Client ID and Secret?

You must contact your Paylocity Account Manager or the Paylocity Web Services team to request API credentials. They will provide the Client ID and Client Secret for the WebLink API.

Where do I get the Company ID?

Your Company ID is the unique identifier for your organization in Paylocity, typically a 5 or 6 digit number used when logging into the Paylocity portal.

Can I see an employee's direct deposit setup?

Yes! Use the `get_employee_direct_deposit` tool with an Employee ID to retrieve the configured bank accounts and distribution settings.

Paylocity MCP Server for Pydantic AI 10 tools — connect in under 2 minutes

Name: Paylocity
Availability: InStock
Author: Vinkius

ai.pydantic.dev/mcp

Built by Vinkius GDPR 10 Tools SDK

Pydantic AI brings type-safe agent development to Python with first-class MCP support. Connect Paylocity through the Vinkius and every tool is automatically validated against Pydantic schemas — catch errors at build time, not in production.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

python

import asyncio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerHTTP

async def main():
    # Your Vinkius token — get it at cloud.vinkius.com
    server = MCPServerHTTP(url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")

    agent = Agent(
        model="openai:gpt-4o",
        mcp_servers=[server],
        system_prompt=(
            "You are an assistant with access to Paylocity "
            "(10 tools)."
        ),
    )

    result = await agent.run(
        "What tools are available in Paylocity?"
    )
    print(result.data)

asyncio.run(main())

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About Paylocity MCP Server

Connect your Paylocity account to any AI agent and take full control of your HR and payroll administration through natural conversation.

Pydantic AI validates every Paylocity tool response against typed schemas, catching data inconsistencies at build time. Connect 10 tools through the Vinkius and switch between OpenAI, Anthropic, or Gemini without changing your integration code — full type safety, structured output guarantees, and dependency injection for testable agents.

What you can do

Workforce Visibility — List all employees and retrieve detailed profiles, including contact info and job metadata.
Earnings & Deductions Tracking — Inspect specific earning codes and deduction setups for any employee.
Onboarding Oversight — List employees currently in the onboarding process to track hiring progress.
Payroll Auditing — Retrieve local tax configurations, direct deposit settings, and benefit setups to ensure compliance.
Custom Data Retrieval — Access custom fields defined in your Paylocity environment for specific reporting needs.

The Paylocity MCP Server exposes 10 tools through the Vinkius. Connect it to Pydantic AI in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect Paylocity to Pydantic AI via MCP

Follow these steps to integrate the Paylocity MCP Server with Pydantic AI.

Install Pydantic AI

Run pip install pydantic-ai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Run the agent

Save to agent.py and run: python agent.py

Explore tools

The agent discovers 10 tools from Paylocity with type-safe schemas

Why Use Pydantic AI with the Paylocity MCP Server

Pydantic AI provides unique advantages when paired with Paylocity through the Model Context Protocol.

Full type safety: every MCP tool response is validated against Pydantic models, catching data inconsistencies before they reach your application

Model-agnostic architecture — switch between OpenAI, Anthropic, or Gemini without changing your Paylocity integration code

Structured output guarantee: Pydantic AI ensures tool results conform to defined schemas, eliminating runtime type errors

Dependency injection system cleanly separates your Paylocity connection logic from agent behavior for testable, maintainable code

Paylocity + Pydantic AI Use Cases

Practical scenarios where Pydantic AI combined with the Paylocity MCP Server delivers measurable value.

Type-safe data pipelines: query Paylocity with guaranteed response schemas, feeding validated data into downstream processing

API orchestration: chain multiple Paylocity tool calls with Pydantic validation at each step to ensure data integrity end-to-end

Production monitoring: build validated alert agents that query Paylocity and output structured, schema-compliant notifications

Testing and QA: use Pydantic AI's dependency injection to mock Paylocity responses and write comprehensive agent tests

Paylocity MCP Tools for Pydantic AI (10)

These 10 tools become available when you connect Paylocity to Pydantic AI via MCP:

get_employee

Get details for a specific employee

get_employee_benefit_setup

Get benefit configuration for an employee

get_employee_custom_fields

Get custom field values for an employee

get_employee_deductions

Get deduction details for an employee

get_employee_direct_deposit

Get direct deposit setup for an employee

get_employee_earnings

Get earning details for an employee

get_employee_emergency_contacts

Get emergency contacts for an employee

get_employee_local_taxes

Get local tax setup for an employee

list_employees

List all employees in the company

list_onboarding_employees

List employees currently in onboarding

Example Prompts for Paylocity in Pydantic AI

Ready-to-use prompts you can give your Pydantic AI agent to start working with Paylocity immediately.

"List all employees in our company."

"Show me the earnings and deductions for employee 12345."

"Who is currently in the onboarding process?"

Troubleshooting Paylocity MCP Server with Pydantic AI

Common issues when connecting Paylocity to Pydantic AI through the Vinkius, and how to resolve them.

MCPServerHTTP not found

Update: pip install --upgrade pydantic-ai

Paylocity + Pydantic AI FAQ

Common questions about integrating Paylocity MCP Server with Pydantic AI.

How does Pydantic AI discover MCP tools?

Create an MCPServerHTTP instance with the server URL. Pydantic AI connects, discovers all tools, and generates typed Python interfaces automatically.

Does Pydantic AI validate MCP tool responses?

Yes. When you define result types as Pydantic models, every tool response is validated against the schema. Invalid data raises a clear error instead of silently corrupting your pipeline.

Can I switch LLM providers without changing MCP code?

Absolutely. Pydantic AI abstracts the model layer — your Paylocity MCP integration works identically with OpenAI, Anthropic, Google, or any supported provider.