Skip to main content
Glama
vilaabo

zephyr-scale-mcp

by vilaabo
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

update_test_plan

Idempotent

Partially update a Zephyr Scale test plan: only the fields you provide are changed; omitted fields keep their values. Returns the test plan key.

Instructions

Update a Zephyr Scale test plan (PUT /testplan/{testPlanKey}). PARTIAL update: only the fields you pass are changed; omitted fields keep their current values — never send empty placeholders. projectKey cannot be changed. The same constraints as create_test_plan apply: the folder must be an existing TEST_PLAN folder, status is case-sensitive, owner is a Jira user key. Returns { key }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoTest plan name
ownerNoOwner. Jira *user key* (e.g. 'JIRAUSER10000'), NOT a username or e-mail — resolve it with find_jira_user.
folderNoFull TEST_PLAN folder path from the root starting with "/", e.g. "/Releases/2026". The folder MUST already exist — create it first with create_folder using type TEST_PLAN.
labelsNoLabels; the API replaces spaces with underscores
statusNoTest plan status. Defaults: 'Draft', 'Approved', 'Deprecated' — case-sensitive; instances may define custom ones.
objectiveNoObjective (HTML allowed)
issueLinksNoJira issue keys to link, e.g. ["PROJ-123"]
testPlanKeyYesTest plan key, e.g. PROJ-P123
customFieldsNoCustom field values keyed by field name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.2
  2. Removed
  3. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations only provide idempotentHint; description adds that it's a partial update, projectKey is immutable, and constraints from create_test_plan apply (folder existence, status case-sensitivity). Returns { key } gives basic output. No contradictions.

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?

Approximately 5 sentences, front-loaded with the partial update key point. Dense with useful info, no fluff, though could be slightly more compact.

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?

Covers main behavioral rules (partial update, immutable projectKey, constraints from create), and returns basic output shape. Good for a 9-parameter tool with nested objects, but no mention of versioning or conflict handling.

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 has 100% coverage; description adds value by noting partial update semantics, that owner must be a Jira user key resolved via find_jira_user, and that folder must already exist. Exceeds baseline.

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?

Clearly states it updates a Zephyr Scale test plan via PUT, specifies it's a partial update (only passed fields change), and contrasts with create_test_plan by noting the endpoint and immutable projectKey.

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?

Explicitly describes the partial update behavior, warns against sending empty placeholders, mentions projectKey cannot be changed, and directs to resolve owner via find_jira_user, with references to create_test_plan constraints.

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