Skip to main content
Glama
vilaabo

zephyr-scale-mcp

by vilaabo

update_test_case

Idempotent

Partially update a Zephyr Scale test case by providing only fields to change. For step-by-step scripts, pass the complete list of steps with existing ids to modify, create, or delete steps.

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?

Beyond the idempotentHint annotation, the description discloses detailed behavioral traits such as partial update semantics, step synchronization logic (create/update/delete by id), and the return shape ({ key, url }). These are not inferred from annotations alone.

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?

The description is concise (about 6 sentences), well-structured, and front-loaded with the primary purpose and key caveats. Every sentence provides essential information without 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?

Given the complexity (15 parameters, nested objects, step synchronization) and the absence of an output schema, the description provides sufficient context for correct usage. It explains the partial update, step rules, return value, and directs to an alternative tool for simpler cases.

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

Parameters4/5

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

With 100% schema coverage, the baseline is 3. The description adds value by explaining the step synchronization behavior in a holistic way and by warning that projectKey cannot be changed. However, most parameter details are already covered by the schema, so the increment is modest.

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?

The description clearly states 'Update a Zephyr Scale test case' and specifies the HTTP method (PUT), the resource (test case), and the partial update behavior. It distinguishes itself from siblings like create_test_case and add_test_steps by explicitly noting that only passed fields are changed and that for simple step addition, add_test_steps is preferred.

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?

The description provides explicit guidance on when to use this tool versus alternatives: it recommends using add_test_steps for merely adding steps, and it warns that projectKey cannot be changed. This informs the agent's decision-making.

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