Penfold Partner API

Health check

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.getpenfold.dev/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Penfold Partner API MCP server": {
    "url": "https://docs.getpenfold.dev/mcp"
  }
}
Close
GET /healthz

Liveness check. Returns successfully when the API is able to serve requests.

Responses

  • 204

    Service is healthy

  • 500 application/json

    One or more health checks failed

    Hide response attribute Show response attribute object
    • error string

      A descriptive error message.
GET /healthz 
curl \
 --request GET 'https://payroll-api.getpenfold.dev/v4/healthz'
Response examples (500) 
{
  "error": "Bad request: invalid data provided."
}