Skip to main content
Glama
vilaabo

zephyr-scale-mcp

by vilaabo

create_test_case

Creates a test case in Zephyr Scale and returns its key and URL. Supports step-by-step, plain text, or BDD scripts with parameters, labels, and custom fields.

Instructions

Create a Zephyr Scale test case (POST /testcase). Returns { key, url } with a key like PROJ-T123. Constraints: the folder, if given, MUST already exist — the API never creates folders (use create_folder first); status and priority are case-sensitive internal names (defaults 'Draft'/'Approved'/'Deprecated' and 'High'/'Normal'/'Low'; instances may define custom ones); owner is a Jira user key like JIRAUSER10000 (resolve with find_jira_user); estimatedTime is in milliseconds. testScript formats: STEP_BY_STEP with steps (a step carrying testCaseKey is a 'Call to Test' that inlines another test case), PLAIN_TEXT with text, or BDD with text holding ONLY Gherkin step lines (Given/When/Then/And/But, stored verbatim) — do NOT include 'Feature:'/'Scenario:' headers, the API rejects them with 400 'Invalid BDD Script'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesTest 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>}] }
projectKeyNoJira project key; defaults to ZEPHYR_DEFAULT_PROJECT_KEY
testScriptNoTest script. STEP_BY_STEP: {type, steps: [{description?, testData?, expectedResult?, testCaseKey?}]}; PLAIN_TEXT/BDD: {type, text}.
customFieldsNoCustom field values keyed by field name
preconditionNoPrecondition (HTML allowed)
estimatedTimeNoEstimated duration in milliseconds
Behavior4/5

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

Covers API constraints (folder existence, BDD rejection with 400, key format, case sensitivity, millisecond units). Annotations are empty, so description carries full burden. Missing explicit mention of idempotency but creation is inherently non-idempotent.

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

Conciseness4/5

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

Front-loaded with key info (endpoint, return format). Every sentence adds value despite length. Could be slightly more concise but remains clear and well-structured.

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 15 parameters, complex nested objects, and no output schema, the description is remarkably complete. Covers all critical aspects: folder prerequisite, status/priority case sensitivity, script format rules, estimatedTime units, and references sibling tools.

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?

Schema coverage is 100%, but description adds significant value: explains BDD restriction in detail, owner resolution workflow, testScript structure beyond schema. The extra context justifies a 4 over baseline 3.

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 'Create a Zephyr Scale test case (POST /testcase)' and specifies the return format '{ key, url }'. It distinguishes the tool from siblings like 'update_test_case' and 'clone_test_case' by focusing on creation.

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 extensive guidance: folder must exist (use create_folder first), owner must be a Jira user key (resolve with find_jira_user), status/priority case-sensitive with defaults, script format rules (BDD without headers). Explicitly tells when to use other tools.

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