Skip to content

Be first in. Get early access

PeriodGuard

All documentation

Agent access

An AI agent can read the change history of the businesses on your account through the API or the MCP server, with the same filters as the web app: for example, what changed in a closed month for one client since Friday. Agents read; connecting and disconnecting businesses stays in the web app.

Discover the product

  • https://periodguard.com/llms.txt: a plain-text summary written for language models.
  • https://periodguard.com/.well-known/product.json: a machine-readable description of the feature, its inputs and outputs, prices and endpoints.
  • https://periodguard.com/api/v1/openapi.json: the OpenAPI 3.1 document, generated from the same schemas the server validates with.

Call the API

Authenticate with an API key and send X-Usage-Source: agent so the account's usage meter attributes the results to agents rather than to plain API calls. The header is advisory: it changes reporting, never the price.

POST /api/v1/changes
Authorization: Bearer periodguard_live_…
X-Usage-Source: agent
Content-Type: application/json

{"closedOnly": true, "from": "2026-11-01", "limit": 50}

MCP server

The product ships an MCP server that exposes the feature as one tool. It runs on the agent's side and calls the API with the agent's key:

{
  "mcpServers": {
    "periodguard": {
      "command": "npm",
      "args": ["run", "mcp", "--prefix", "/path/to/periodguard"],
      "env": {
        "PRODUCT_API_URL": "https://periodguard.com",
        "PRODUCT_API_KEY": "periodguard_live_…"
      }
    }
  }
}

The tool is named changes and its input schema matches the API: businessId, recordType, from, to, closedOnly, user, search and limit, all optional. Each answer lists the businesses on the account and the changes, newest first, each with its fields before and after, who made it and whether it is in a closed period. Queries are metered exactly like API calls, with source agent.

Prices for agents

One query counts once against the plan's monthly allowance, however many changes it returns. When the allowance is used up, queries from an account with a card on file are billed at $0.01 each. Free accounts get 100 queries a month and HTTP 402 afterwards, with a link to the pricing page.

Rules for agents

  • Respect Retry-After on 429 responses.
  • Do not create more API keys than you need; key management is deliberately session-only.
  • Read error.message; it is written to be acted on.