Skip to main content
Glama
qase-tms

Qase MCP Server

Official
by qase-tms

Create or update test case

qase_case_upsert

Create or update a single Qase test case: include an ID to update, omit it to create. For multiple cases, use bulk create.

Instructions

Create or update a single test case: with id it updates, without it creates. Enum fields accept a label such as "high" or the project's numeric ID. Writing more than one case? Use qase_case_bulk_create — one request instead of one per case. If the project has "Test case review" enabled, writes may need a review — run qase_discover_tools with "review". Cost: one API call, about 0.6s to create, 0.4s to update.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoCase ID — if provided, updates the case; if omitted, creates a new one
codeYesProject code, e.g. DEMO
tagsNoTag names, e.g. ["smoke", "billing"]
typeNoType label or numeric ID
layerNoLayer label or numeric ID
stepsNoOrdered test steps; omit for a case without steps
titleYesTest case title
statusNoStatus label or numeric ID
behaviorNoBehavior label or numeric ID
is_flakyNoIs flaky: 0=No, 1=Yes; a boolean works too.
priorityNoPriority label or numeric ID (0=not set, 1=high, 2=medium, 3=low)
severityNoSeverity label or numeric ID
suite_idNoID of the suite that holds the case
automationNoAutomation: 0=Manual, 1=To be automated, 2=Automated (label or ID)
steps_typeNoStep style: "classic" action/expected, or "gherkin" scenario text
attachmentsNoHashes from qase_attachment_upload
descriptionNoFree-form description of what the case covers
custom_fieldNoCustom fields by ID, e.g. { "12": "value" }
milestone_idNoID of the milestone the case belongs to
preconditionsNoState the system must be in before the steps run
postconditionsNoState to restore or verify after the steps run

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "step": {
      +    "properties": {
      +      "action": {
      +        "description": "Step action (classic steps). Not needed when `shared` is set.",
      +        "type": "string"
      +      },
      +      "attachments": {
      +        "description": "Hashes from qase_attachment_upload",
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "data": {
      +        "description": "Test data",
      +        "type": "string"
      +      },
      +      "expected_result": {
      +        "description": "Expected result",
      +        "type": "string"
      +      },
      +      "shared": {
      +        "description": "Hash from `qase_shared_step_upsert` to reuse here; then `action` is not needed.",
      +        "type": "string"
      +      },
      +      "shared_step_hash": {
      +        "description": "Alias for `shared`, the spelling a case reads back.",
      +        "type": "string"
      +      },
      +      "steps": {
      +        "description": "Nested substeps, nesting further if needed.",
      +        "items": {
      +          "$ref": "#/$defs/step"
      +        },
      +        "type": "array"
      +      },
      +      "value": {
      +        "description": "Gherkin scenario text (when steps_type is \"gherkin\")",
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  }
      +}
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / attachments / description
      Previous value: -"Attachment hashes from qase_attachment_upload"New value: +"Hashes from qase_attachment_upload"
    • changedInput schema / properties / automation / description
      Previous value: -"Automation status (label, slug, or numeric ID: 0=Manual / is-not-automated, 1=To be automated, 2=Automated)"New value: +"Automation: 0=Manual, 1=To be automated, 2=Automated (label or ID)"
    • changedInput schema / properties / code / description
      Previous value: -"Project code (2-10 uppercase letters, numbers, or underscores)"New value: +"Project code, e.g. DEMO"
    • changedInput schema / properties / custom_field / description
      Previous value: -"Custom field values keyed by field ID, e.g. { \"12\": \"value\" }"New value: +"Custom fields by ID, e.g. { \"12\": \"value\" }"
    • addedInput schema / properties / custom_field / propertyNames
      Added value: +{
      +  "type": "string"
      +}
    • changedInput schema / properties / is_flaky / description
      Previous value: -"Is flaky label or numeric ID (0=No, 1=Yes). A boolean is accepted too."New value: +"Is flaky: 0=No, 1=Yes; a boolean works too."
    • addedInput schema / properties / steps / items / $ref
      Added value: +"#/$defs/step"
    • removedInput schema / properties / steps / items / additionalProperties
      Removed value: -false
    • removedInput schema / properties / steps / items / properties
      Removed value: -{
      -  "action": {
      -    "description": "Step action (classic steps). Not needed when `shared` is set.",
      -    "type": "string"
      -  },
      -  "attachments": {
      -    "description": "Attachment hashes from qase_attachment_upload",
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  "data": {
      -    "description": "Test data",
      -    "type": "string"
      -  },
      -  "expected_result": {
      -    "description": "Expected result",
      -    "type": "string"
      -  },
      -  "shared": {
      -    "description": "Hash of an existing shared step to insert at this position, from `qase_shared_step_upsert`. The step then reuses that shared step instead of defining its own content, so `action` can be omitted. Reading the case back reports the link as `shared_step_hash`.",
      -    "type": "string"
      -  },
      -  "shared_step_hash": {
      -    "description": "Alias for `shared` — the name used when reading a case. Sent to the API as `shared`.",
      -    "type": "string"
      -  },
      -  "steps": {
      -    "description": "Nested substeps. Same structure as parent steps, supports further nesting.",
      -    "items": {
      -      "additionalProperties": true,
      -      "properties": {
      -        "action": {
      -          "description": "Step action (classic steps). Not needed when `shared` is set.",
      -          "type": "string"
      -        },
      -        "attachments": {
      -          "description": "Attachment hashes from qase_attachment_upload",
      -          "items": {
      -            "type": "string"
      -          },
      -          "type": "array"
      -        },
      -        "data": {
      -          "description": "Test data",
      -          "type": "string"
      -        },
      -        "expected_result": {
      -          "description": "Expected result",
      -          "type": "string"
      -        },
      -        "shared": {
      -          "description": "Hash of an existing shared step to insert at this position, from `qase_shared_step_upsert`. The step then reuses that shared step instead of defining its own content, so `action` can be omitted. Reading the case back reports the link as `shared_step_hash`.",
      -          "type": "string"
      -        },
      -        "shared_step_hash": {
      -          "description": "Alias for `shared` — the name used when reading a case. Sent to the API as `shared`.",
      -          "type": "string"
      -        },
      -        "value": {
      -          "description": "Gherkin scenario text (when steps_type is \"gherkin\")",
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "type": "array"
      -  },
      -  "value": {
      -    "description": "Gherkin scenario text (when steps_type is \"gherkin\")",
      -    "type": "string"
      -  }
      -}
    • removedInput schema / properties / steps / items / type
      Removed value: -"object"
    • changedInput schema / properties / steps_type / description
      Previous value: -"How steps are written: \"classic\" action/expected pairs, or \"gherkin\" scenario text"New value: +"Step style: \"classic\" action/expected, or \"gherkin\" scenario text"
  2. Changed9 schema fields changedv2.5.1
    • addedInput schema / properties / custom_field / description
      Added value: +"Custom field values keyed by field ID, e.g. { \"12\": \"value\" }"
    • addedInput schema / properties / description / description
      Added value: +"Free-form description of what the case covers"
    • addedInput schema / properties / milestone_id / description
      Added value: +"ID of the milestone the case belongs to"
    • addedInput schema / properties / postconditions / description
      Added value: +"State to restore or verify after the steps run"
    • addedInput schema / properties / preconditions / description
      Added value: +"State the system must be in before the steps run"
    • addedInput schema / properties / steps / description
      Added value: +"Ordered test steps; omit for a case without steps"
    • addedInput schema / properties / steps_type / description
      Added value: +"How steps are written: \"classic\" action/expected pairs, or \"gherkin\" scenario text"
    • addedInput schema / properties / suite_id / description
      Added value: +"ID of the suite that holds the case"
    • addedInput schema / properties / tags / description
      Added value: +"Tag names, e.g. [\"smoke\", \"billing\"]"
  3. Changed2 schema fields changedv2.5.0
    • addedInput schema / properties / is_flaky / description
      Added value: +"Is flaky label or numeric ID (0=No, 1=Yes). A boolean is accepted too."
    • changedInput schema / properties / is_flaky / type
      Previous value: -"boolean"New value: +"string"
  4. Changed3 schema fields changedv2.2.1
    • addedInput schema / properties / attachments / description
      Added value: +"Attachment hashes from qase_attachment_upload"
    • changedInput schema / properties / steps / items / properties / attachments / description
      Previous value: -"Attachment hashes"New value: +"Attachment hashes from qase_attachment_upload"
    • changedInput schema / properties / steps / items / properties / steps / items / properties / attachments / description
      Previous value: -"Attachment hashes"New value: +"Attachment hashes from qase_attachment_upload"
  5. Changed6 schema fields changedv2.0.3
    • changedInput schema / properties / steps / items / properties / action / description
      Previous value: -"Step action (classic steps)"New value: +"Step action (classic steps). Not needed when `shared` is set."
    • addedInput schema / properties / steps / items / properties / shared
      Added value: +{
      +  "description": "Hash of an existing shared step to insert at this position, from `qase_shared_step_upsert`. The step then reuses that shared step instead of defining its own content, so `action` can be omitted. Reading the case back reports the link as `shared_step_hash`.",
      +  "type": "string"
      +}
    • addedInput schema / properties / steps / items / properties / shared_step_hash
      Added value: +{
      +  "description": "Alias for `shared` — the name used when reading a case. Sent to the API as `shared`.",
      +  "type": "string"
      +}
    • changedInput schema / properties / steps / items / properties / steps / items / properties / action / description
      Previous value: -"Step action (classic steps)"New value: +"Step action (classic steps). Not needed when `shared` is set."
    • addedInput schema / properties / steps / items / properties / steps / items / properties / shared
      Added value: +{
      +  "description": "Hash of an existing shared step to insert at this position, from `qase_shared_step_upsert`. The step then reuses that shared step instead of defining its own content, so `action` can be omitted. Reading the case back reports the link as `shared_step_hash`.",
      +  "type": "string"
      +}
    • addedInput schema / properties / steps / items / properties / steps / items / properties / shared_step_hash
      Added value: +{
      +  "description": "Alias for `shared` — the name used when reading a case. Sent to the API as `shared`.",
      +  "type": "string"
      +}
  6. Addedv2.0.0

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With only destructiveHint=false in annotations, the description carries most of the burden and does well: it discloses the review-gating workflow, per-operation latency cost, and the enum label-vs-numeric-ID convention. It does not state what happens to fields omitted on an update (partial merge vs. overwrite), which for an upsert tool is the remaining behavioral unknown.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Six tight sentences, front-loaded with the create/update rule, then scaling guidance, then prerequisites, then cost. No filler and nothing buried at the end that an agent needs first.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 21-parameter tool with nested step objects and no output schema, the description covers the operation branch, sibling routing, and the review gate. The one omission is update semantics for partially supplied parameters, though 100% schema coverage and the absence of an output schema limit the severity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3. The description adds the useful convention that enum fields accept a label like 'high' or a numeric ID, but the schema already repeats 'label or numeric ID' on each such parameter, so the added meaning is marginal rather than substantial.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource pair ('create or update a single test case') and immediately disambiguates the upsert semantics: id present means update, absent means create. This cleanly separates it from sibling qase_case_bulk_create and qase_case_delete without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes multi-case writes to qase_case_bulk_create with the reason ('one request instead of one per case'), and names qase_discover_tools with the 'review' query when the project has Test case review enabled. Both an alternative and a conditional prerequisite are given, not implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.