Check CLI

# Mac / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

git clone https://github.com/check-technologies/mcp-server-check.git
cd mcp-server-check
uv sync

export CHECK_API_KEY=your-api-key-here
uv run check --help

uv tool install -e .
check --help

# See all top-level resource categories
check --help

# See all commands for a resource
check companies --help
check employees --help
check payrolls --help

# See options for a specific command
check employees list --help

# List all companies
check companies list

# Get a specific company
check companies get com_xxxxx

# List employees in table format
check employees list --company com_xxxxx --format table

# Preview a payroll before approving
check payrolls preview prl_xxxxx

# Approve a payroll
check payrolls approve prl_xxxxx

# Get W-4 tax parameters for an employee
check tax params list --employee emp_xxxxx

# Default JSON output
check companies list

# Table format for quick lookups
check employees list --company com_xxxxx --format table

# Extract all employee IDs for a company
check employees list --company com_xxxxx | jq '.results[].id'

# Get a count of active employees
check employees list --company com_xxxxx | jq '.results | length'

# Export employee data to CSV
check employees list --company com_xxxxx | jq -r '.results[] | [.id, .first_name, .last_name] | @csv'

# Find all pending payrolls
check payrolls list --company com_xxxxx | jq '.results[] | select(.status == "pending")'

# Get details for each employee
check employees list --company com_xxxxx | jq -r '.results[].id' | \
  xargs -I{} check employees get {}

# Read-only mode — disables all create, update, and delete operations
export CHECK_READ_ONLY=true

# Limit to specific resource categories
export CHECK_TOOLSETS=companies,employees

# Exclude individual commands
export CHECK_EXCLUDE_TOOLS=create_bank_account

# Combine all three
export CHECK_API_KEY=your-api-key-here
export CHECK_READ_ONLY=true
export CHECK_TOOLSETS=companies,employees
export CHECK_EXCLUDE_TOOLS=reveal_employee_ssn

# Via flag
check --env production payrolls list

# Via environment variable
export CHECK_ENV=production
check payrolls list

# Or set the base URL directly
export CHECK_API_BASE_URL=https://api.checkhq.com
export CHECK_API_KEY=your-production-api-key

# Create a payroll
check payrolls create \
  --company com_xxxxx \
  --period-start 2026-01-01 \
  --period-end 2026-01-15 \
  --payday 2026-01-20

# Add a payroll item
check payroll-items create \
  --payroll prl_xxxxx \
  --employee emp_xxxxx \
  --earnings '[{"amount":"5000.00","earning_code":"ec_xxxxx"}]'

# Preview the payroll
check payrolls preview prl_xxxxx

# Approve it
check payrolls approve prl_xxxxx

# Simulate processing (sandbox only)
check payrolls simulate-start-processing prl_xxxxx
check payrolls simulate-complete-funding prl_xxxxx
check payrolls simulate-complete-disbursements prl_xxxxx

# Create an employee
check employees create \
  --company com_xxxxx \
  --first-name Jane \
  --last-name Doe \
  --email [email protected] \
  --start-date 2026-02-01

# Onboard them
check employees onboard emp_xxxxx

# Check their forms
check employees list-forms emp_xxxxx

# Payroll journal
check companies get-payroll-journal-report com_xxxxx \
  --start-date 2026-01-01 --end-date 2026-03-31

# Tax liabilities
check companies get-tax-liabilities-report com_xxxxx \
  --start-date 2026-01-01 --end-date 2026-03-31

# W-2 preview
check companies get-w2-preview-report com_xxxxx --year 2025

# List webhook configs
check webhooks list-configs

# Create a webhook
check webhooks create-config \
  --url https://example.com/webhooks \
  --environment sandbox

# Test it
check webhooks ping-config whc_xxxxx