MCP Access

Reportkey provides an experimental MCP bridge for automation tools that prefer the Model Context Protocol instead of direct REST calls.

Current status

  • Status: preview
  • Base URL: https://api.reportkey.net
  • Auth: the same personal access tokens and scopes as direct REST usage
  • Scope: public /api/v1/ routes only

What the bridge exposes today

  • account_me
  • projects_list
  • project_get
  • project_reports_list
  • report_get
  • project_jobs_list
  • job_get
  • generation_job_get
  • generation_job_start
  • export_job_get
  • export_job_start

The bridge does not expose token management, billing actions, or binary file proxying. For completed exports it returns the same artifact.download_url metadata that the public API already provides.

Auth and behavior

  • Configure the bridge with REPORTKEY_API_BASE_URL and REPORTKEY_API_TOKEN.
  • Use the same bearer tokens and scopes as direct REST consumers.
  • The same access rules, limits, and error codes apply as in REST.
  • Errors such as authentication_required, invalid_token, api_access_required, rate_limit_exceeded, quota_exceeded, and api_controls_unavailable can surface through MCP tool errors.

Bridge configuration

  • Public API host: https://api.reportkey.net

Example:

REPORTKEY_API_BASE_URL="https://api.reportkey.net" \
REPORTKEY_API_TOKEN="rkpat_yourpublicid.yoursecret" \
npm --prefix mcp/reportkey-public-api-bridge run start

Current limitations

  • The public API remains the source of truth for automation behavior.
  • Binary export downloads are still consumed through the returned download URL.
  • Preview tooling may change before general availability.