SmartBear MCP server

1<div align="center">
2  <a href="https://www.smartbear.com">
3    <picture>
4      <source media="(prefers-color-scheme: dark)" srcset="https://assets.smartbear.com/m/79b99a7ff9c81a9a/original/SmartBear-Logo_Dark-Mode.svg">
5      <img alt="SmartBear logo" src="https://assets.smartbear.com/m/105001cc5db1e0bf/original/SmartBear-Logo_Light-Mode.svg">
6    </picture>
7  </a>
8  <h1>SmartBear MCP server</h1>
9 
10  <!-- Badges -->
11  <div>
12    <a href="https://github.com/SmartBear/smartbear-mcp/actions/workflows/test.yml"><img src="https://github.com/SmartBear/smartbear-mcp/actions/workflows/test.yml/badge.svg?branch=main" alt="Test Status"></a>
13    <a href="https://smartbear.github.io/smartbear-mcp/"><img src="https://img.shields.io/badge/coverage-dynamic-brightgreen" alt="Coverage"></a>
14    <a href="https://www.npmjs.com/package/@smartbear/mcp"><img src="https://img.shields.io/npm/v/@smartbear/mcp" alt="npm version"></a>
15    <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-Compatible-blue" alt="MCP Compatible"></a>
16    <a href="https://developer.smartbear.com/smartbear-mcp"><img src="https://img.shields.io/badge/documentation-latest-blue.svg" alt="Documentation"></a>
17  </div>
18</div>
19<br />
20 
21A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including [BearQ](https://developer.smartbear.com/smartbear-mcp/docs/bearq-integration), [BugSnag](https://www.bugsnag.com/), [Reflect](https://reflect.run), [Swagger](https://www.smartbear.com/api-hub), [PactFlow](https://pactflow.io/), [Pact Broker](https://docs.pact.io/), [QMetry](https://www.qmetry.com/), [QTM4J](https://www.qmetry.com/qmetry-test-management-for-jira), [Zephyr](https://smartbear.com/test-management/zephyr/) and [Collaborator](https://smartbear.com/product/collaborator/).
22 
23## What is MCP?
24 
25The [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) is an open standard that enables AI assistants to securely connect to external data sources and tools. This server exposes SmartBear's APIs through natural language interfaces, allowing you to query your testing data, analyze performance metrics, and manage test automation directly from your AI workflow.
26 
27## Supported Tools
28 
29See individual guides for suggested prompts and supported tools and resources:
30 
31- [BearQ](https://developer.smartbear.com/smartbear-mcp/docs/bearq-integration) - AI-powered QA test management and execution capabilities
32- [BugSnag](https://developer.smartbear.com/smartbear-mcp/docs/bugsnag-integration) - Comprehensive error monitoring and debugging capabilities
33- [Reflect](https://developer.smartbear.com/smartbear-mcp/docs/reflect-integration) - Test management and execution capabilities
34- **Swagger**
35  - [Portal](https://developer.smartbear.com/smartbear-mcp/docs/swagger-portal-integration) - Portal and product management capabilities
36  - [Studio](https://developer.smartbear.com/smartbear-mcp/docs/swagger-studio-integration) - API and Domain management capabilities, including AI-powered API generation from prompts and automatic standardization
37  - [Contract Testing (PactFlow)](https://developer.smartbear.com/pactflow/default/getting-started) - Contract testing capabilities
38  - [Functional Testing](https://developer.smartbear.com/smartbear-mcp/docs/swagger-functional-testing-integration) - API test discovery capabilities
39- [QMetry](https://developer.smartbear.com/smartbear-mcp/docs/qmetry-integration) - QMetry Test Management capabilities
40- [Zephyr](https://developer.smartbear.com/smartbear-mcp/docs/zephyr-integration) - Zephyr Test Management capabilities
41- [Collaborator](https://developer.smartbear.com/smartbear-mcp/docs/collaborator-integration) - Review and Remote System Configuration management capabilities
42- [QTM4J](https://developer.smartbear.com/smartbear-mcp/docs/qtm4j-integration) - QTM4J Test Management for Jira capabilities
43 
44## Remote MCP Servers
45 
46For BugSnag, Swagger, and Zephyr, SmartBear hosts Remote MCP Servers that you can connect to directly from your MCP client via a URL — no installation, Node.js, or API tokens required. Authentication is handled through an OAuth browser flow.
47 
48| Product | Server URL |
49|---|---|
50| **Swagger** | `https://swagger.mcp.smartbear.com/mcp` |
51| **BugSnag** | `https://bugsnag.mcp.smartbear.com/mcp` |
52| **Zephyr** | `https://zephyr.mcp.smartbear.com/mcp` |
53 
54See the [Remote MCP Servers guide](https://developer.smartbear.com/smartbear-mcp/docs/remote-mcp-servers) for per-client setup instructions. You can connect to multiple remote servers at the same time.
55 
56> **Need BearQ, Reflect, QMetry, QTM4J, PactFlow, Collaborator, or Functional Testing?** These products are only available via the local npm package below, which bundles all products into a single MCP server.
57 
58## Prerequisites
59 
60- Node.js 20+ and npm
61- Access to SmartBear products (BugSnag, Reflect, Swagger, QMetry, QTM4J or Zephyr)
62- Valid API tokens for the products you want to integrate
63 
64## Local MCP Server Installation (npm)
65 
66For all products — or if you prefer running the server locally — the MCP server is distributed as an npm package [`@smartbear/mcp`](https://www.npmjs.com/package/@smartbear/mcp), making it easy to integrate into your development workflow.
67 
68The server is started with the API key or auth token that you use with your SmartBear product(s). They are optional and can be removed from your configuration if you aren't using the product. For BugSnag, if you provide a project API key it will narrow down all searches to a single project in your BugSnag dashboard. Leave this field blank if you wish to interact across multiple projects at a time.
69 
70### VS Code with Copilot
71 
72For the quickest setup, use the "MCP: Add server…" command in the Command Palette to add the `@smartbear/mcp` npm package.
73 
74<details>
75<summary><strong>📋 Manual installation</strong></summary>
76 
77Alternatively, you can use `npx` (or globally install) the `@smartbear/mcp` package to run the server and add the following to your `.vscode/mcp.json` file:
78 
79```json
80{
81  "servers": {
82    "smartbear": {
83      "type": "stdio",
84      "command": "npx",
85      "args": [
86        "-y",
87        "@smartbear/mcp@latest"
88      ],
89      "env": {
90        "BEARQ_API_TOKEN": "${input:bearq_api_token}",
91        "BEARQ_API_BASE_URL": "${input:bearq_api_base_url}",
92        "BUGSNAG_AUTH_TOKEN": "${input:bugsnag_auth_token}",
93        "BUGSNAG_PROJECT_API_KEY": "${input:bugsnag_project_api_key}",
94        "REFLECT_API_TOKEN": "${input:reflect_api_token}",
95        "SWAGGER_API_KEY": "${input:swagger_api_key}",
96        "SWAGGER_PORTAL_BASE_PATH": "${input:swagger_portal_base_path}",
97        "SWAGGER_REGISTRY_BASE_PATH": "${input:swagger_registry_base_path}",
98        "SWAGGER_UI_BASE_PATH": "${input:swagger_ui_base_path}",
99        "PACT_BROKER_BASE_URL": "${input:pact_broker_base_url}",
100        "PACT_BROKER_TOKEN": "${input:pact_broker_token}",
101        "PACT_BROKER_USERNAME": "${input:pact_broker_username}",
102        "PACT_BROKER_PASSWORD": "${input:pact_broker_password}",
103        "QMETRY_API_KEY": "${input:qmetry_api_key}",
104        "QMETRY_BASE_URL": "${input:qmetry_base_url}",
105        "ZEPHYR_API_TOKEN": "${input:zephyr_api_token}",
106        "ZEPHYR_BASE_URL": "${input:zephyr_base_url}",
107        "COLLABORATOR_BASE_URL": "${input:collab_base_url}",
108        "COLLABORATOR_USERNAME": "${input:collab_username}",
109        "COLLABORATOR_LOGIN_TICKET": "${input:collab_login_ticket}",
110        "QTM4J_API_KEY": "${input:qtm4j_api_key}",
111        "QTM4J_BASE_URL": "${input:qtm4j_base_url}",
112        "QTM4J_AUTOMATION_API_KEY": "${input:qtm4j_automation_api_key}",
113        "SWAGGER_FUNCTIONAL_TESTING_API_TOKEN": "${input:swagger_functional_testing_api_token}",
114        "SWAGGER_FUNCTIONAL_TESTING_BASE_PATH": "${input:swagger_functional_testing_base_path}"
115      }
116    }
117  },
118  "inputs": [
119      {
120         "id": "bearq_api_token",
121         "type": "promptString",
122         "description": "BearQ workspace API token - leave blank to disable BearQ tools",
123         "password": true
124      },
125      {
126         "id": "bearq_api_base_url",
127         "type": "promptString",
128         "description": "BearQ API base URL - leave blank to use the default (https://api.bearq.smartbear.com)",
129         "password": false
130      },
131      {
132         "id": "bugsnag_auth_token",
133         "type": "promptString",
134         "description": "BugSnag Auth Token - leave blank to disable BugSnag tools",
135         "password": true
136      },
137      {
138         "id": "bugsnag_project_api_key",
139         "type": "promptString",
140         "description": "BugSnag Project API Key - for single project interactions",
141         "password": false
142      },
143      {
144         "id": "reflect_api_token",
145         "type": "promptString",
146         "description": "Reflect API Token - leave blank to disable Reflect tools",
147         "password": true
148      },
149      {
150         "id": "swagger_api_key",
151         "type": "promptString",
152         "description": "Swagger API Key - leave blank to disable Swagger tools",
153         "password": true
154      },
155      {
156         "id": "swagger_portal_base_path",
157         "type": "promptString",
158         "description": "Swagger Portal API base path - only needed for on-premise installations (leave blank for cloud)",
159         "password": false
160      },
161      {
162         "id": "swagger_registry_base_path",
163         "type": "promptString",
164         "description": "Swagger Registry API base path - only needed for on-premise installations (leave blank for cloud)",
165         "password": false
166      },
167      {
168         "id": "swagger_ui_base_path",
169         "type": "promptString",
170         "description": "Swagger UI base path - only needed for on-premise installations (leave blank for cloud)",
171         "password": false
172      },
173      {
174         "id": "pact_broker_base_url",
175         "type": "promptString",
176         "description": "PactFlow or Pact Broker base url - leave blank to disable the tools",
177         "password": true
178      },
179      {
180         "id": "pact_broker_token",
181         "type": "promptString",
182         "description": "PactFlow Authentication Token",
183         "password": true
184      },
185      {
186         "id": "pact_broker_username",
187         "type": "promptString",
188         "description": "Pact Broker Username",
189         "password": true
190      },
191      {
192         "id": "pact_broker_password",
193         "type": "promptString",
194         "description": "Pact Broker Password",
195         "password": true
196      },
197      {
198          "id": "qmetry_api_key",
199          "type": "promptString",
200          "description": "QMetry Open API Key",
201          "password": true
202      },
203      {
204          "id": "qmetry_base_url",
205          "type": "promptString",
206          "description": "By default, connects to https://testmanagement.qmetry.com. Change to a custom QMetry server URL or a region-specific endpoint if needed.",
207          "password": false
208      },
209      {
210          "id": "zephyr_api_token",
211          "type": "promptString",
212          "description": "Zephyr API token - leave blank to disable Zephyr tools",
213          "password": true
214      },
215      {
216          "id": "zephyr_base_url",
217          "type": "promptString",
218          "description": "Zephyr API base URL. By default, connects to https://api.zephyrscale.smartbear.com/v2. Change to region-specific endpoint if needed.",
219          "password": false
220      },
221      {
222          "id": "collab_base_url",
223          "type": "promptString",
224          "description": "Collab base url",
225          "password": true
226      },
227      {
228          "id": "collab_username",
229          "type": "promptString",
230          "description": "Collab username",
231          "password": true
232      },
233      {
234          "id": "collab_login_ticket",
235          "type": "promptString",
236          "description": "Collab login ticket",
237          "password": true
238      },
239      {
240          "id": "qtm4j_api_key",
241          "type": "promptString",
242          "description": "QTM4J API Key",
243          "password": true
244    },
245    {
246          "id": "qtm4j_base_url",
247          "type": "promptString",
248          "description": "US region (default): https://qtmcloud.qmetry.com. Australia region: https://syd-qtmcloud.qmetry.com.",
249          "password": false
250    },
251    {
252          "id": "qtm4j_automation_api_key",
253          "type": "promptString",
254          "description": "QTM4J Automation API Key - required for automation tools, leave blank to disable them",
255          "password": true
256    },
257    {
258          "id": "swagger_functional_testing_api_token",
259          "type": "promptString",
260          "description": "Swagger Functional Testing API Token - leave blank to disable Functional Testing tools",
261          "password": true
262    },
263    {
264          "id": "swagger_functional_testing_base_path",
265          "type": "promptString",
266          "description": "Swagger Functional Testing API Base URL - leave blank to use the default (https://api.reflect.run/v1)",
267          "password": false
268    }
269  ]
270}
271```
272</details>
273 
274### Claude Desktop
275 
276Add the following configuration to your `claude_desktop_config.json` to launch the MCP server via `npx`:
277 
278```json
279{
280  "mcpServers": {
281    "smartbear": {
282      "command": "npx",
283      "args": [
284        "-y",
285        "@smartbear/mcp@latest"
286      ],
287      "env": {
288        "BEARQ_API_TOKEN": "your_bearq_api_token",
289        "BUGSNAG_AUTH_TOKEN": "your_personal_auth_token",
290        "BUGSNAG_PROJECT_API_KEY": "your_project_api_key",
291        "REFLECT_API_TOKEN": "your_reflect_token",
292        "SWAGGER_API_KEY": "your_swagger_key",
293        "SWAGGER_PORTAL_BASE_PATH": "https://api.portal.swaggerhub.com/v1",
294        "SWAGGER_REGISTRY_BASE_PATH": "https://api.swaggerhub.com",
295        "SWAGGER_UI_BASE_PATH": "https://app.swaggerhub.com",
296        "PACT_BROKER_BASE_URL": "your_pactflow_or_pactbroker_base_url",
297        "PACT_BROKER_TOKEN": "your_pactflow_token",
298        "PACT_BROKER_USERNAME": "your_pact_broker_username",
299        "PACT_BROKER_PASSWORD": "your_pact_broker_password",
300        "QMETRY_API_KEY": "your_qmetry_api_key",
301        "QMETRY_BASE_URL": "https://testmanagement.qmetry.com",
302        "ZEPHYR_API_TOKEN": "your_zephyr_api_token",
303        "ZEPHYR_BASE_URL": "https://api.zephyrscale.smartbear.com/v2",
304        "COLLABORATOR_BASE_URL": "your collab base url",
305        "COLLABORATOR_USERNAME": "your collab user name",
306        "COLLABORATOR_LOGIN_TICKET": "your collab login ticket",
307        "QTM4J_API_KEY": "your_qtm4j_key",
308        "QTM4J_BASE_URL": "https://qtmcloud.qmetry.com",
309        "QTM4J_AUTOMATION_API_KEY": "your_qtm4j_automation_api_key",
310        "SWAGGER_FUNCTIONAL_TESTING_API_TOKEN": "your_swagger_functional_testing_api_token",
311        "SWAGGER_FUNCTIONAL_TESTING_BASE_PATH": "https://api.reflect.run/v1"
312      }
313    }
314  }
315}
316```
317 
318## Documentation
319 
320For detailed introduction, examples, and advanced configuration visit our 📖 [Full Documentation](https://developer.smartbear.com/smartbear-mcp)
321 
322## Local Development
323 
324For developers who want to contribute to the SmartBear MCP server, please see the [CONTRIBUTING.md](CONTRIBUTING.md) guide.
325 
326## License
327 
328This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the [LICENSE](LICENSE.txt) file in the project repository.
329 
330## Support
331 
332* [Search open and closed issues](https://github.com/SmartBear/smartbear-mcp/issues?utf8=✓&q=is%3Aissue) for similar problems
333* [Report a bug or request a feature](https://github.com/SmartBear/smartbear-mcp/issues/new)
334 
335 
336---
337 
338**SmartBear MCP Server** - Bringing the power of SmartBear's testing and monitoring ecosystem to your AI-powered development workflow.
339