Skip to content

SmartBear/smartbear-mcp

Repository files navigation

SmartBear logo

SmartBear MCP server

An MCP server for SmartBear's API Hub, Test Hub and Insight Hub.

Usage

The server is started with the API key or auth token that you use with your product(s). They are optional and can be removed from your configuration if you aren't using the product.

VS Code

Add the @smartbear/mcp package to your project via NPM or via the "MCP: Add server…" command in VS Code.

If setting up manually, add the following configuration to .vscode/mcp.json:

{
  "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
      }
  ]
}

MCP Inspector

To test the MCP server using the npm package, run:

REFLECT_API_TOKEN=your_reflect_token INSIGHT_HUB_AUTH_TOKEN=your_insight_hub_token API_HUB_API_KEY=your_api_hub_api_key npx @smartbear/mcp

This will open an inspector window in your browser, where you can test the tools.

Supported Tools

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

Environment Variables

  • INSIGHT_HUB_AUTH_TOKEN: Required for Insight Hub tools. The Auth Token for Insight Hub.
  • REFLECT_API_TOKEN: Required for Reflect tools. The Reflect Account API Key for Reflect-based tools.
  • API_HUB_API_KEY: Required for API Hub tools. The API Key for API Hub tools.
  • MCP_SERVER_INSIGHT_HUB_API_KEY: Optional. If set, enables error reporting of the MCP_server code via the BugSnag SDK. This is useful for debugging and monitoring of the MCP server itself and shouldn't be set to the same API key as your app.

See individual guides for product-specific configuration via environment variables.

Local Development

If you want to build and run the MCP server from source (for development or contribution):

Build

Clone this repository and run:

npm install
npm run build

Usage (Local Build)

Update your .vscode/mcp.json to point to your local build:

{
  "servers": {
    "smartbear": {
      "type": "stdio",
      "command": "node",
      "args": ["<PATH_TO_SMARTBEAR_MCP>/dist/index.js"],
      "env": {
        // ...same as above...
      }
    }
  },
  "inputs": [
    // ...same as above...
  ]
}

Or run the server directly:

REFLECT_API_TOKEN=your_reflect_token INSIGHT_HUB_AUTH_TOKEN=your_insight_hub_token API_HUB_API_KEY=your_api_hub_api_key node dist/index.js

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.