Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Zephyr: Create Test Case Web Link

zephyr_create_test_case_web_link

Attaches a web link to a Zephyr test case by providing the test case key, URL, and optional description.

Instructions

Create a new Web Link for a Test Case in Zephyr

Toolset: Test Cases

Parameters:

  • description (string): The web link description

  • url (string) required: The web link URL

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

Examples:

  1. Create a web link for test case SA-T1 pointing to Atlassian's homepage

{
  "testCaseKey": "SA-T1",
  "url": "https://www.atlassian.com",
  "description": "Link to Atlassian's homepage"
}

Expected Output: The newly created Web Link with its ID and self link

  1. Attach a documentation link to test case MM2-T15 for pump specifications

{
  "testCaseKey": "MM2-T15",
  "url": "https://docs.atlassian.com",
  "description": "Documentation for pump specifications"
}

Expected Output: The newly created Web Link with its ID and self link

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe web link URL
descriptionNoThe web link description
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
selfNo
Behavior3/5

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

Annotations already indicate this is a write operation (readOnlyHint=false) but not destructive (destructiveHint=false). The description adds context about the toolset and expected output, but does not disclose additional behavioral traits like authorization or side effects.

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?

The description is well-structured with sections for toolset, parameters, and examples. It is concise without unnecessary elaboration, earning its sentences.

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?

With a clear description, 100% schema coverage, and output schema present, the description adequately covers the tool's purpose and usage. Examples further enhance completeness.

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?

Schema coverage is 100%, and the description provides redundant parameter explanations with pattern and examples. This adds marginal value beyond the schema, meeting the baseline for high schema coverage.

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 it creates a web link for a test case, with specific verb 'Create' and resource 'Web Link for a Test Case'. It distinguishes from sibling tools like 'zephyr_create_test_case_issue_link' by focusing on web links.

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 implies usage through examples but does not explicitly state when to use this tool versus alternatives. No exclusion criteria or when-not-to-use guidance is provided.

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