zephyr-squad-server-mcp
Provides tools for managing Zephyr Squad test cycles, folders, executions, test steps, step results, and ZQL search within Jira, enabling AI agents to drive Zephyr for Jira Server/Data Center test management.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@zephyr-squad-server-mcplist test cycles for project PROJ in version 1.0"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
zephyr-squad-server-mcp
An MCP server that lets an AI agent drive Zephyr for Jira — Server / Data Center (ZAPI), the test-management suite for Jira. It exposes the most common test-management operations (cycles, folders, executions, test steps, step results, ZQL search) as well-described tools over stdio, so it plugs into Claude Desktop, Claude Code, and any other MCP client.
This targets the Server/DC flavor (
/rest/zapi/latest). It is not for Zephyr Squad Cloud, which uses a different JWT-signed API.
Install
The server is published on PyPI and is easiest to run with
uv:
uvx zephyr-squad-server-mcp # run directly, no install
# or
uv tool install zephyr-squad-server-mcp
# or, in a venv
pip install zephyr-squad-server-mcpRelated MCP server: Zephyr Scale MCP Server
Configuration
The connection rides on your Jira instance's authentication (shared by ZAPI and
the Jira core REST API). Configure via environment variables or a .env file
(see .env.example):
Variable | Required | Default | Description |
| ✅ | — | Jira base URL, e.g. |
| one of | — | Personal Access Token → |
| one of | — | Basic-auth fallback (password or API token). Used only if |
|
| ZAPI base path on the Jira host. | |
|
| Per-request timeout (seconds). | |
|
| Verify TLS certs. Set |
The server fails fast with a clear error if the base URL or authentication is missing.
Client configuration (stdio)
Add to your MCP client config (e.g. Claude Desktop claude_desktop_config.json
or Claude Code .mcp.json):
{
"mcpServers": {
"zephyr-squad": {
"command": "uvx",
"args": ["zephyr-squad-server-mcp"],
"env": {
"JIRA_BASE_URL": "https://jira.company.com",
"JIRA_PAT": "your-personal-access-token"
}
}
}
}For local development against a checkout, point command at uv:
{
"mcpServers": {
"zephyr-squad": {
"command": "uv",
"args": ["run", "--directory", "/path/to/zephyr-squad-server-mcp", "zephyr-squad-server-mcp"],
"env": { "JIRA_BASE_URL": "https://jira.company.com", "JIRA_PAT": "…" }
}
}
}Tools
All id-bearing tools accept either a numeric id or a human-friendly
key/name for project (key like SONY or its name), version (name like
Version 1.0, or -1/Unscheduled), and issue (key like SONY-1386).
Resolved ids are cached for the session, so the first call does the lookup and
later calls reuse it.
Full reference: see
docs/tools.mdfor every tool's arguments, types, defaults, the exact ZAPI endpoint it calls, and sync/async behavior. The table below is a quick index.
Tool | What it does |
| List test cycles for a project/version. |
| Get one cycle's details (id |
| Create a test cycle. |
| Update a cycle's fields (id is sent in the body). |
| Delete a cycle (async; auto-polls to completion by default). |
| Get a CSV download link for a cycle's executions. |
| Copy executions into a cycle (async; auto-polls to completion by default). |
| Move executions from a cycle into a folder (async; auto-polls to completion by default). |
| List folders within a cycle. |
| Create a folder under a cycle. |
| Update a folder's name/description. |
| Delete a folder from a cycle (async; auto-polls to completion by default). |
| List executions in a cycle (optionally a folder). |
| Set an execution's status (PASS/FAIL/WIP/BLOCKED/…). |
| List the test steps of a test issue. |
| Add a test step to a test issue. |
| List per-step results for an execution. |
| Run a ZQL query and return matching executions. |
| Status-count rollup for a project/version (by cycle). |
| Per-assignee status counts for cycle(s). |
| A single test's executions across all cycles. |
| Defects linked to an execution. |
| Tests covering requirement(s); flags orphans. |
| Executions for a test (coverage history). |
| Executions linked to a defect. |
| Per-defect execution/req/test rollups. |
| Edit a test step's action/data/result. |
| Delete a test step. |
| Schedule a test into a cycle. |
| Bulk-add an explicit list of tests to a cycle as new UNEXECUTED executions (async). |
| Bulk-add tests matched by a saved ZQL filter to a cycle as new UNEXECUTED executions (async). |
| Add tests from another cycle as new UNEXECUTED executions (async). |
| Set a step result's status/comment. |
| Link Jira defects to executions (async). |
| Assign an execution to a user. |
| Delete an execution by id. |
| Manually poll any async job by token. |
| List projects (name → id discovery). |
| List a project's versions (name → id discovery). |
| Discover the Zephyr Test issue-type id per project (use case 1.1). |
Dates use Jira's dd/MMM/yy format (e.g. 4/Dec/12). Execution-status codes:
-1=UNEXECUTED, 1=PASS, 2=FAIL, 3=WIP, 4=BLOCKED, 5=PENDING, 6=APPROVED, 7=CANCELLED.
Development
uv sync # create venv + install deps (incl. dev group)
uv run pytest # unit tests (httpx mocked with respx — no live Jira needed)
uv run ruff check # lint
uv run mcp dev src/zephyr_squad_server_mcp/server.py # MCP Inspector smoke testdocs/getzephyr.apib is the ZAPI API Blueprint used as the
reference for request/response shapes during development. It was retrieved from the
official public documentation at https://getzephyr.docs.apiary.io/ (© SmartBear
Software). An older version is also available in the
zfjdeveloper/zapi-docs repository.
The Inspector (mcp dev) launches the MCP Inspector via npx, so it needs
Node.js / npx on your PATH. The tool list loads without any Jira config, but
invoking a tool builds the client on first use — so set JIRA_BASE_URL and
auth (a .env is read automatically) before running tools.
Publishing to PyPI
uv build # produces wheel + sdist in dist/
uv publish --token "$UV_PUBLISH_TOKEN" # or set UV_PUBLISH_TOKEN in the envTest against TestPyPI first:
uv publish --publish-url https://test.pypi.org/legacy/ --token "$TESTPYPI_TOKEN"License
MIT — see LICENSE.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
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/alejandroviera/zephyr-squad-server-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server