Create a test plan

testplan.createChanges dataCreates, updates or deletes something in your workspace.

What it does

Creates a test plan: a named, reusable bundle of existing test cases you want to run together (for example a "Checkout smoke" plan with the five most important checkout cases). Call testplan.list first, because a plan with the same name in the workspace is refused, and case.list to get the test case ids to include. Returns { success, message, id, uri } with the new plan id. A plan does not run anything by itself: to execute its cases, pass the same test case ids to testrun.create.

Ask your agent

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

  • “Group the login and checkout tests into a smoke test plan”
  • “Create a regression plan with every payment test case”
  • “Make a release acceptance plan for version 2.0”

Inputs

NameTypeDescription
name
required
stringPlan name, unique within the workspace, e.g. "Checkout smoke". A name that already exists is refused.
description
optional
stringOptional plain-language note on what the plan covers and when to run it, e.g. "Run before every deploy to production".
kind
optional
enumWhat kind of bundle this is. smoke = a few fast checks that the app basically works; sanity = a quick check of one area after a change; security = security-focused checks; regression = the broad set that proves nothing that used to work is broken; release-acceptance = the checks a release must pass before shipping; custom = anything else. Defaults to "custom". Used to filter plan listings.
Allowed: smokesanitysecurityregressionrelease-acceptancecustom
status
optional
enumLifecycle status. ACTIVE = in use and shown in pickers; INACTIVE = archived, kept but hidden from pickers. When omitted the plan is stored as active.
Allowed: ACTIVEINACTIVE
priority
optional
enumOptional plan priority, P0 = most important, P3 = least. Returned by testplan.list.
Allowed: P0P1P2P3
testCaseIds
required
string[]Test cases to include, at least one. Use the internal id from case.list (e.g. ["AAtc-kzqd-mwpe-rtya-hbnc-xufo-lgsi"]), not the human caseId like "GenTC-0001".

The MCP call

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

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "testplan.create",
    "arguments": {
      "name": "<name>",
      "testCaseIds": [
        "<testCaseId>"
      ]
    }
  }
}

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.