Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Zephyr: Get Test Case

zephyr_get_test_case
Read-onlyIdempotent

Fetch details of a Zephyr test case by providing its test case key.

Instructions

Get details of test case specified by key 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 case with key 'SA-T10'

{
  "testCaseKey": "SA-T10"
}

Expected Output: The test case with its details

  1. Get the test case with key 'MM2-T1'

{
  "testCaseKey": "MM2-T1"
}

Expected Output: The test case with its details

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
idYesThe ID of the entity
keyYesThe test case key
nameYes
linksNoA list of links for this test case.
ownerNo
folderNoID and link to the folder resource.
labelsNoArray of labels associated to this entity.
statusYesID and link to the status resource.
projectYesID and link relative to Zephyr project.
priorityYesID and link to the priority resource.
componentNoID and link to the Jira component resource.
createdOnNoData and time test case was created. Format: yyyy-MM-dd'T'HH:mm:ss'Z'. This field is read-only, cannot be updated.
objectiveNoA description of the objective.
testScriptNo
customFieldsNoMulti-line text fields support HTML and should denote new lines with the \<br\> tag. Dates should be in the format 'yyyy-MM-dd'. Users should have values of Jira User Account IDs.
preconditionNoAny conditions that need to be met.
estimatedTimeNoEstimated duration in milliseconds.
Behavior3/5

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

Annotations already confirm readOnly, idempotent, and non-destructive behavior. The description adds that it returns 'details' of the test case, but does not disclose any additional behavioral traits like error handling or rate limits. No contradiction with annotations.

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 extremely concise with a clear purpose, structured parameter list, and useful examples. Every sentence serves a purpose; no extraneous information.

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?

Given the presence of an output schema and thorough annotations, the description covers the essential use case. It lacks guidance on handling invalid keys or error responses, but is otherwise complete for a simple getter.

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% for the single parameter, so baseline is 3. The description adds value by providing explicit examples of valid key formats (e.g., 'SA-T10'), which aids understanding beyond the schema 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 verb 'Get' and resource 'test case', specifying that the key is used to identify it. It distinguishes from sibling tools like zephyr_get_test_cases (plural) by indicating a single test case retrieval.

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

Usage Guidelines3/5

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

The description provides examples but no explicit guidance on when to use this tool versus alternatives (e.g., search or list tools). The toolset label 'Test Cases' offers context, but no when-not-to-use or exclusion criteria.

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/SmartBear/smartbear-mcp'

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