List product KPIs

What it does

Lists the product KPIs in the connected workspace, newest first. A KPI (key performance indicator) is a number that tells you whether the whole product is doing well, such as weekly active users or monthly revenue. For numbers about one feature (like checkout conversion rate) use featuremetric.list instead. Call it before productkpi.create to avoid duplicates, or to find the id for metric.observe. Returns {items: [{id, uri, name, unit, direction, targetValue, status}], totalItems, page, pageSize}. direction is higher-better or lower-better; status is active or archived. Read-only. Recorded values over time are in the resource testmaze://metric-observations/{spaceId}/product/{id}.

Ask your agent

You don’t call productkpi.list yourself. Say something like this to Claude Code, Cursor or another MCP-connected agent:

• “What KPIs are we tracking for the product?”
• “Are we already measuring weekly active users?”

Inputs

The MCP call

What the agent’s MCP client sends (placeholders in angle brackets):

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "productkpi.list",
    "arguments": {
      "page": 1
    }
  }
}

Connect your agent

npx -y @testmaze/mcp init tmt_xxx
claude mcp add tm --scope project -- npx -y @testmaze/mcp

Create the token in your Test Maze workspace under Settings → MCP. Setup for Cursor, Cline, Gemini CLI and Codex CLI is shown there too.

More success metrics tools

• List per-feature success metrics featuremetric.list
• Create a product KPI productkpi.create
• Create a success metric for a feature featuremetric.create
• Record a metric value metric.observe