Creating a Zephyr API Key

[Yshmael Ammonraheem]

how do I generate a Zephyr API key for the Zephyr MCP server. I am using cursor to attempt to connect to my Zephyr instance. I have already installed a Zephyr MCP server. When I attempt to connect to Zephr this is what I get from cursor 

What you need to do

1. In Jira, open your profile (bottom-left avatar) → Zephyr API keys (or Zephyr Scale → API keys).
2. Generate a new Zephyr Scale API key.
3. In ~/.cursor/mcp.json, set ZEPHYR_API_KEY to that Zephyr key (not the Jira token).
4. Keep JIRA_USERNAME and JIRA_API_TOKEN as they are — those are for Jira issue linking only.
5. Reload MCP servers in Cursor: Settings → MCP → restart/reload the zephyr-server.

After you update the key

Say “retry Zephyr” and I can run get_folders for project STAF to confirm the connection.

If you share the Zephyr API key (or paste it into mcp.json yourself), I can verify the connection end-to-end. I won’t put secrets in chat unless you explicitly want that.

Within Jira, I cannot find any reference to creating a Zephyr API Key.

[Marc -Devoteam-]

Hi @Yshmael Ammonraheem 

Welcome to the community.

Within Atlassian you can't create Zephyr API keys, this needs to be done on the Zephyr end.

Google is you better friend in here; https://docs.zephyr-cloud.io/features/automation#creating-an-api-token 

You see, don't take an AI answer as the truth!

[Tinker Fadoua]

Welcome to the Atlassian Community @Yshmael Ammonraheem 

In your case it will be better to raise a support ticket with the vendor.

Best,

Fadoua

[Jason Krewson]

What Zephyr product are you using?

As I think there are different ways to get this depending on that, you could always check their documentation as well, they will have steps on how to generate the API. 

Checking their documentation I found this Create and Manage API Tokens in Zephyr , hopefully its for the right product. 

Hope that helps!

[Yshmael Ammonraheem]

Zephyr Cloud 

[Jason Krewson]

Oh Zephyr Cloud, I have this also.

To get the API token go to your Jira Profile (top right click on yourself) > in this list you should see "Zephyr API Access Tokens" - click on that > click Create access token. 

 They also have 2 references for API:

•  REST API (overview) 
• Zephyr Cloud API (2)