Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Zephyr: Get Test Script

zephyr_get_test_script
Read-onlyIdempotent

Retrieve the test script (plain text or BDD) for any Zephyr test case using its key, returning script type, content, and id.

Instructions

Get the Test Script (Plain Text or BDD) for a given Test Case in Zephyr

Toolset: Test Cases

Parameters:

  • testCaseKey (string) required: The key of the test case. Test case keys are of the format [A-Z]+-T[0-9]+

Examples:

  1. Get the test script for test case with key 'SA-T1'

{
  "testCaseKey": "SA-T1"
}

Expected Output: The test script with its type (plain or bdd), text content, and id

  1. Retrieve the BDD test script content for test case with key 'MM2-T15'

{
  "testCaseKey": "MM2-T15"
}

Expected Output: The test script with its type (plain or bdd), text content, and id

  1. Get the test script for test case with key 'QA-T100' to review the test instructions

{
  "testCaseKey": "QA-T100"
}

Expected Output: The test script with its type (plain or bdd), text content, and id

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
testCaseKeyYesThe key of the test case. Test case keys are of the format [A-Z]+-T[0-9]+

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoThe ID of the entity
textYes
typeYesTest scripts can be written in plain text or BDD format. The BDD type supports remote execution on a build system via API plugin. Supported Keywords for BDD: Given, When, Then, And, But. For more information about BDD and Gherkin syntax, see: https://support.smartbear.com/zephyr/docs/en/test-cases/gherkin-behavior-driven-development--bdd-.html For Plain Text scripts, we support HTML fragments. To create a step-by-step test script, you should use the POST /testcases/{testCaseKey}/teststeps endpoint.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.40.0
  2. Removedv0.34.0
  3. Changed1 schema field changedv0.30.0
    • addedOutput schema / description
      Added value: +"Response body when retrieving test scripts"
  4. First observedv0.27.1

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the read-only safety profile is covered. The description adds useful output context by specifying the script type, text content, and id, but it does not go beyond what a simple read operation would imply.

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

Conciseness3/5

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

The description is reasonably organized but contains redundancy: the parameter section duplicates the schema, and the same expected output is repeated in all three examples. The first sentence is clear, but several sentences do not earn their place.

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 single-parameter read-only tool with an output schema and full annotations, the description is complete enough for an agent to call it correctly. It identifies the required parameter, describes the resource being fetched, and gives concrete examples.

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?

The input schema fully documents testCaseKey, including format guidance, so the baseline is 3. The description repeats this same information rather than adding new semantic detail, and the examples only illustrate valid key formats already captured in the pattern.

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 the specific action: getting the Test Script for a given Test Case, and distinguishes it from related sibling tools such as zephyr_get_test_case and zephyr_create_test_script by focusing on the script artifact in Plain Text or BDD form. The resource and operation are unambiguous.

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

Usage Guidelines4/5

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

The description establishes a clear context for use: retrieve the Test Script for a specific Test Case, with examples showing realistic applications such as reviewing test instructions. It does not explicitly mention alternatives or when not to use this tool, so it misses the full exclusionary guidance that would justify a 5.

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

Deploy Server

Other Tools