SmartBear MCP Server

What is SmartBear MCP Server about?

The server exposes SmartBear’s suite of testing and monitoring APIs through a Model Context Protocol (MCP) endpoint, allowing AI assistants to retrieve, analyze, and act upon data from tools such as BugSnag, Reflect, Swagger, PactFlow, QMetry, Zephyr, and Collaborator.

How to use SmartBear MCP Server?

1. Prerequisites – Install Node.js 20+ and obtain API tokens for the desired SmartBear products.
2. Installation – Run the server with the npm package @smartbear/mcp (e.g., via npx).
3. Configuration – Provide the required environment variables (API tokens, keys, and base URLs) in a VS Code mcp.json or Claude Desktop config file.
4. Interaction – Issue natural‑language prompts to an MCP‑compatible AI assistant; the assistant translates them into API calls handled by the server.

Key features of SmartBear MCP Server

• Unified MCP interface for multiple SmartBear products.
• Supports both single‑project and multi‑project scopes (e.g., BugSnag project API key).
• Easy VS Code integration via the “MCP: Add server…” command.
• Declarative configuration through .vscode/mcp.json or Claude Desktop JSON.
• MIT‑licensed, open‑source implementation.

Use cases of SmartBear MCP Server

• Debugging – Ask an AI assistant to list recent error events from BugSnag across all projects or a specific one.
• Test Management – Retrieve test case status from QMetry or Zephyr and automatically generate progress reports.
• API Exploration – Query Swagger portals or studios for endpoint details, then generate client code snippets.
• Contract Testing – Pull PactFlow verification results and surface compatibility warnings.
• Code Review Automation – Search Collaborator for pending reviews and summarize findings.

FAQ from the SmartBear MCP Server

Q: Do I need to provide tokens for every integrated tool? A: No. Tokens are optional; omit any you don’t plan to use and the corresponding integration will be disabled.

Q: Can I run the server locally without internet access? A: The server itself runs locally, but it must reach SmartBear’s cloud APIs, so internet connectivity is required for actual data retrieval.

Q: Which AI assistants are compatible? A: Any assistant that implements the Model Context Protocol, including Copilot, Claude, and other MCP‑compatible models.

Q: How do I update the package? A: Run npm update @smartbear/mcp or reinstall via npx -y @smartbear/mcp@latest.

Q: Where can I find contribution guidelines? A: See the CONTRIBUTING.md file in the repository for details on building and testing the project.

A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including BugSnag, Reflect, Swagger, PactFlow, Pact Broker, QMetry, Zephyr and Collaborator.

What is MCP?

The Model Context Protocol (MCP) 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.

Supported Tools

See individual guides for suggested prompts and supported tools and resources:

• BugSnag - Comprehensive error monitoring and debugging capabilities
• Test Hub - Test management and execution capabilities
• Swagger
  • Portal - Portal and product management capabilities
  • Studio - API and Domain management capabilities
  • Contract Testing (PactFlow) - Contract testing capabilities
• QMetry - QMetry Test Management capabilities
• Zephyr - Zephyr Test Management capabilities
• Collaborator - Review and Remote System Configuration management capabilities

Prerequisites

• Node.js 20+ and npm
• Access to SmartBear products (BugSnag, Reflect, Swagger, QMetry, or Zephyr)
• Valid API tokens for the products you want to integrate

Installation

The MCP server is distributed as an npm package @smartbear/mcp, making it easy to integrate into your development workflow.

The 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.

VS Code with Copilot

For the quickest setup, use the "MCP: Add server…" command in the Command Palette to add the @smartbear/mcp npm package.

Alternatively, 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:

{
  "servers": {
    "smartbear": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@smartbear/mcp@latest"
      ],
      "env": {
        "BUGSNAG_AUTH_TOKEN": "${input:bugsnag_auth_token}",
        "BUGSNAG_PROJECT_API_KEY": "${input:bugsnag_project_api_key}",
        "REFLECT_API_TOKEN": "${input:reflect_api_token}",
        "SWAGGER_API_KEY": "${input:swagger_api_key}",
        "PACT_BROKER_BASE_URL": "${input:pact_broker_base_url}",
        "PACT_BROKER_TOKEN": "${input:pact_broker_token}",
        "PACT_BROKER_USERNAME": "${input:pact_broker_username}",
        "PACT_BROKER_PASSWORD": "${input:pact_broker_password}",
        "QMETRY_API_KEY": "${input:qmetry_api_key}",
        "QMETRY_BASE_URL": "${input:qmetry_base_url}",
        "ZEPHYR_API_TOKEN": "${input:zephyr_api_token}",
        "ZEPHYR_BASE_URL": "${input:zephyr_base_url}",
        "COLLAB_BASE_URL": "${input:collab_base_url}",
        "COLLAB_USERNAME": "${input:collab_username}",
        "COLLAB_LOGIN_TICKET": "${input:collab_login_ticket}"
      }
    }
  },
  "inputs": [
      {
         "id": "bugsnag_auth_token",
         "type": "promptString",
         "description": "BugSnag Auth Token - leave blank to disable BugSnag tools",
         "password": true
      },
      {
         "id": "bugsnag_project_api_key",
         "type": "promptString",
         "description": "BugSnag Project API Key - for single project interactions",
         "password": false
      },
      {
         "id": "reflect_api_token",
         "type": "promptString",
         "description": "Reflect API Token - leave blank to disable Reflect tools",
         "password": true
      },
      {
         "id": "swagger_api_key",
         "type": "promptString",
         "description": "Swagger API Key - leave blank to disable Swagger tools",
         "password": true
      },
      {
         "id": "pact_broker_base_url",
         "type": "promptString",
         "description": "PactFlow or Pact Broker base url - leave blank to disable the tools",
         "password": true
      },
      {
         "id": "pact_broker_token",
         "type": "promptString",
         "description": "PactFlow Authentication Token",
         "password": true
      },
      {
         "id": "pact_broker_username",
         "type": "promptString",
         "description": "Pact Broker Username",
         "password": true
      },
      {
         "id": "pact_broker_password",
         "type": "promptString",
         "description": "Pact Broker Password",
         "password": true
      },
      {
          "id": "qmetry_api_key",
          "type": "promptString",
          "description": "QMetry Open API Key",
          "password": true
      },
      {
          "id": "qmetry_base_url",
          "type": "promptString",
          "description": "By default, connects to https://testmanagement.qmetry.com. Change to a custom QMetry server URL or a region-specific endpoint if needed.",
          "password": false
      },
      {
          "id": "zephyr_api_token",
          "type": "promptString",
          "description": "Zephyr API token - leave blank to disable Zephyr tools",
          "password": true
      },
      {
          "id": "zephyr_base_url",
          "type": "promptString",
          "description": "Zephyr API base URL. By default, connects to https://api.zephyrscale.smartbear.com/v2. Change to region-specific endpoint if needed.",
          "password": false
      },
      {
          "id": "collab_base_url",
          "type": "promptString",
          "description": "Collab base url",
          "password": true
      },
      {
          "id": "collab_username",
          "type": "promptString",
          "description": "Collab username",
          "password": true
      },
      {
          "id": "collab_login_ticket",
          "type": "promptString",
          "description": "Collab login ticket",
          "password": true
      }
  ]
}

Claude Desktop

Add the following configuration to your claude_desktop_config.json to launch the MCP server via npx:

{
  "mcpServers": {
    "smartbear": {
      "command": "npx",
      "args": [
        "-y",
        "@smartbear/mcp@latest"
      ],
      "env": {
        "BUGSNAG_AUTH_TOKEN": "your_personal_auth_token",
        "BUGSNAG_PROJECT_API_KEY": "your_project_api_key",
        "REFLECT_API_TOKEN": "your_reflect_token",
        "SWAGGER_API_KEY": "your_swagger_key",
        "PACT_BROKER_BASE_URL": "your_pactflow_or_pactbroker_base_url",
        "PACT_BROKER_TOKEN": "your_pactflow_token",
        "PACT_BROKER_USERNAME": "your_pact_broker_username",
        "PACT_BROKER_PASSWORD": "your_pact_broker_password",
        "QMETRY_API_KEY": "your_qmetry_api_key",
        "QMETRY_BASE_URL": "https://testmanagement.qmetry.com",
        "ZEPHYR_API_TOKEN": "your_zephyr_api_token",
        "ZEPHYR_BASE_URL": "https://api.zephyrscale.smartbear.com/v2",
        "COLLAB_BASE_URL": "your collab base url",
        "COLLAB_USERNAME": "your collab user name",
        "COLLAB_LOGIN_TICKET": "your collab login ticket"
      }
    }
  }
}

Documentation

For detailed introduction, examples, and advanced configuration visit our 📖 Full Documentation

Local Development

For developers who want to contribute to the SmartBear MCP server, please see the CONTRIBUTING.md guide.

License

This 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 file in the project repository.

Support

• Search open and closed issues for similar problems
• Report a bug or request a feature

---

SmartBear MCP Server - Bringing the power of SmartBear's testing and monitoring ecosystem to your AI-powered development workflow.