Integration Assistant MCP
Model Context Protocol (MCP) for API Documentation
Overview
The Integration Assistant MCP enables AI-assisted development tools to securely access and interact with Paylocity API documentation using natural language to reduce the time it takes to discover, design, and implement your integration. When building integrations with Paylocity APIs, partner and client developers can quickly identify the right APIs, understand integration workflows, retrieve relevant documentation, and use that information directly within MCP-enabled coding assistants and code editors.
Setup developer tools to use MCP
This MCP server can be connected to development tools that support MCP client functionality to enable natural language discovery of Paylocity APIs and documentation.
Below are some quick start steps for popular tools. It is recommended to refer to the tool documentation for connector configuration requirements and for any troubleshooting.
Claude Code
Requirements
- Claude subscription enabling MCP Agent capabilities
Setup Steps
Adding an MCP server through the command line will make it available in the Claude Code extension for VS Code as well.
- Open any command prompt or terminal of your choosing.
- Run the following command(s):
claude mcp add --transport http Paylocity_API_Documentation https://developer.paylocity.com/mcp?project=integrations # Optional: Available across all projects for the current user claude mcp add --scope user --transport http Paylocity_API_Documentation https://developer.paylocity.com/mcp?project=integrations # Optional: Available only to the current project claude mcp add --scope project --transport http Paylocity_API_Documentation https://developer.paylocity.com/mcp?project=integrations
Verify setup was completed successfully
- Run
claude mcp listto verify the MCP server was added. - Run
claude mcp get Paylocity_API_Documentationto verify the MCP server is connected.
Claude is now ready to begin referencing Paylocity API documentation for any prompts.
Codex
This applies to the version of Codex included in the newer versions of ChatGPT. This does not apply to the ChatGPT Classic application.
Requirements
- Subscription enabling Codex MCP Agent capabilities
Setup Steps
- Open any command prompt or terminal of your choosing.
- Run the following command:
codex mcp add Paylocity_API_Documentation --url https://developer.paylocity.com/mcp?project=integrations
Verify setup was completed successfully
- Run
codex mcp listto verify the MCP server was added. - Run
codex mcp get Paylocity_API_Documentationto verify the MCP server is connected.
Codex is now ready to begin referencing Paylocity API documentation for any prompts.
GitHub Copilot in VS Code
Requirements
- GitHub Copilot subscription enabling MCP Agent capabilities
Setup Steps
- Open VS Code and locate the Chat window.
- Click on the gear icon (Open Customizations) at the top of the window.
- Click MCP Servers in the side navigation.
- Click "+" (Add Server) button.
- In the Visual Studio Code command box drop down choose the "HTTP (HTTP or Server-Sent Events)" option.
- Input the URL
https://developer.paylocity.com/mcp?project=integrationsand press enter - Input
Paylocity API Documentationas the id and press Enter - Choose Global (Available in all workspaces) or Workspace (Available in this workspace)
- A file called "mcp.json" should open in VS Code, save the file.
- Back in the MCP Servers settings, right click on the new MCP Server and click "Start Server"
- The Output window should show the the server connected and found tools.
- At the bottom of the Chat window near click the sliders icon (Configure Tools...)
- In the drop down ensure "Paylocity API Documentation" is enabled.
Copilot is now ready to begin referencing Paylocity API documentation for any prompts.
Other AI Development Tools
Requirements
- Tool supports acting as a MCP client, connecting to remote 3rd-party servers
- Additional prerequisites such as subscription level to access features are variable depending on the platform
Setup Steps
To connect from other tools or platforms that support acting as an MCP client, follow their guidance documentation on connecting while using the Integration Assistant MCP URL:
https://developer.paylocity.com/mcp?project=integrationsTesting the MCP Client
When testing whether the MCP Client is properly configured and connected, verify that the Integrated Development Environment (IDE) is making tool calls when retrieving documentation. Tool calls are typically recorded in the chat log, and the agent may request permission before executing a tool.
Example Prompts
What APIs does Paylocity provide?
Which Paylocity endpoints would provide me with a company EIN and an employee name and ID?
What would my request body look like for getting a list of company Job codes and what would the response look like?
How can I get all employee time clock data for a given company within a specified time frame? Updated about 19 hours ago