Skip to content

SmartBear/smartbear-mcp

Repository files navigation

SmartBear logo

SmartBear MCP server

Test Status Coverage npm version MCP Compatible Documentation

A Model Context Protocol (MCP) server which provides AI assistants with seamless access to SmartBear's suite of testing and monitoring tools, including Insight Hub, Reflect, and API Hub.

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:

  • Insight Hub - Comprehensive error monitoring and debugging capabilities
  • Test Hub - Test management and execution capabilities
  • API Hub - Portal management capabilities

Prerequisites

  • Node.js 20+ and npm
  • Access to SmartBear products (Insight Hub, Reflect, or API Hub)
  • 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 Insight Hub, if you provide a project API key it will narrow down all searches to a single project in your Insight Hub 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.

📋 Manual installation

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": {
        "INSIGHT_HUB_AUTH_TOKEN": "${input:insight_hub_auth_token}",
        "INSIGHT_HUB_PROJECT_API_KEY": "${input:insight_hub_project_api_key}",
        "REFLECT_API_TOKEN": "${input:reflect_api_token}",
        "API_HUB_API_KEY": "${input:api_hub_api_key}"
      }
    }
  },
  "inputs": [
      {
         "id": "insight_hub_auth_token",
         "type": "promptString",
         "description": "Insight Hub Auth Token - leave blank to disable Insight Hub tools",
         "password": true
      },
      {
         "id": "insight_hub_project_api_key",
         "type": "promptString",
         "description": "Insight Hub 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": "api_hub_api_key",
         "type": "promptString",
         "description": "API Hub API Key - leave blank to disable API Hub tools",
         "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": {
        "INSIGHT_HUB_AUTH_TOKEN": "your_personal_auth_token",
        "INSIGHT_HUB_PROJECT_API_KEY": "your_project_api_key",
        "REFLECT_API_TOKEN": "your_reflect_token",
        "API_HUB_API_KEY": "your_api_hub_key"
      }
    }
  }
}

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, customize its functionality, or work with the latest development features, you can build and run the server directly from source code. This approach gives you full control over the implementation and allows you to make modifications as needed.

  1. Clone the repository:

    git clone https://github.com/SmartBear/smartbear-mcp.git
    cd smartbear-mcp
  2. Install dependencies:

    npm install
  3. Build the server:

    npm run build
  4. Add the server to your IDE configuration updating .vscode/mcp.json (or equivalent) to point to your local build

    📋 VSCode (mcp.json)
    {
      "servers": {
        "smartbear": {
        "type": "stdio",
        "command": "node",
        "dev": {                            // <-- To allow debugging in VS Code
          "watch": "dist/**/*.js",
          "debug": {
              "type": "node"
          },
        },
        "args": ["<PATH_TO_SMARTBEAR_MCP_REPO>/dist/index.js"],
        "env": {
            "INSIGHT_HUB_AUTH_TOKEN": "${input:insight_hub_auth_token}",
            "INSIGHT_HUB_PROJECT_API_KEY": "${input:insight_hub_project_api_key}",
            "REFLECT_API_TOKEN": "${input:reflect_api_token}",
            "API_HUB_API_KEY": "${input:api_hub_api_key}"
          }
        }
      },
      "inputs": [
        {
          "id": "insight_hub_auth_token",
          "type": "promptString",
          "description": "Insight Hub Auth Token - leave blank to disable Insight Hub tools",
          "password": true
        },
        {
          "id": "insight_hub_project_api_key",
          "type": "promptString",
          "description": "Insight Hub 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": "api_hub_api_key",
          "type": "promptString",
          "description": "API Hub API Key - leave blank to disable API Hub tools",
          "password": true
        }
      ]
    }
  5. Local testing using the MCP Inspector web interface:

    INSIGHT_HUB_AUTH_TOKEN="your_token" REFLECT_API_TOKEN="your_reflect_token" API_HUB_API_KEY="your_api_hub_key" npx @modelcontextprotocol/inspector npx @smartbear/mcp@latest

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


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