Skip to main content
Glama
vilaabo

zephyr-scale-mcp

by vilaabo

update_test_case

Idempotent

Partially update a Zephyr Scale test case by specifying only the fields to change; test steps are synchronized by id, with new steps created, existing ones updated, and omitted steps deleted.

Instructions

Update a Zephyr Scale test case (PUT /testcase/{testCaseKey}). PARTIAL update: only the fields you pass are changed; omitted fields keep their current values — never send empty placeholders. projectKey cannot be changed. STEP_BY_STEP step synchronization: when testScript.steps is passed, steps are matched by id — a step WITHOUT an id is CREATED, a step WITH an id is UPDATED, and any existing step MISSING from the list is DELETED. Therefore always pass the COMPLETE final list of steps, carrying over the ids of steps to keep (read them with get_test_case). To merely add steps, prefer add_test_steps, which performs that read-merge-write safely. Returns { key, url }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoTest case name
ownerNoOwner. Jira *user key* (e.g. 'JIRAUSER10000'), NOT a username or e-mail — resolve it with find_jira_user.
folderNoFull folder path from the root starting with "/", e.g. "/Regression/Payments". The folder MUST already exist (create it with create_folder).
labelsNoLabels; the API replaces spaces with underscores
statusNoTest case status. Defaults: 'Draft', 'Approved', 'Deprecated' — case-sensitive; instances may define custom ones.
priorityNoPriority. Defaults: 'High', 'Normal', 'Low' — case-sensitive; instances may define custom ones.
componentNoName of a Jira component of the project
objectiveNoObjective (HTML allowed)
issueLinksNoJira issue keys to link, e.g. ["PROJ-123"]
parametersNoTest case parameters: { variables: [{name, type: FREE_TEXT | DATA_SET, dataSet?}], entries: [{<variable>: <value>}] }
testScriptNoTest script. STEP_BY_STEP: {type, steps: [{description?, testData?, expectedResult?, testCaseKey?}]}; PLAIN_TEXT/BDD: {type, text}.
testCaseKeyYesTest case key, e.g. PROJ-T123
customFieldsNoCustom field values keyed by field name
preconditionNoPrecondition (HTML allowed)
estimatedTimeNoEstimated duration in milliseconds
Behavior5/5

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

Discloses detailed step-by-step synchronization behavior, immutability of projectKey, format constraints (e.g., BDD script body rejection), and return value structure. The idempotentHint annotation is not contradicted; partial update semantics support idempotency.

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?

Every sentence adds value; logically ordered from basic update to step sync rules to alternative tool suggestion to return value. Appropriate length for the complexity, no redundancy.

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

Completeness5/5

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

For a tool with 15 parameters, nested objects, and complex step synchronization, the description covers all critical behaviors, constraints, and return values. No output schema but return format is described.

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

Parameters5/5

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

Schema has 100% description coverage, and description adds critical extra context: owner must be Jira user key, folder must exist, BDD text restrictions, step id logic, and custom fields. Enhances understanding beyond schema alone.

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?

Description clearly states the tool updates a Zephyr Scale test case via PUT, with explicit 'PARTIAL update' behavior. It distinguishes from siblings like add_test_steps and get_test_case by referencing them for alternative workflows.

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?

Provides explicit guidance: never send empty placeholders, step synchronization logic (id-based create/update/delete), and advises using add_test_steps for simply adding steps. Clearly states when to use this tool vs alternatives.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vilaabo/zephyr-scale-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server