Merge pull request #133 from SmartBear/tom/docs-updates-contributing

docs: various docs updates for contributions

Author: tomlongridge

CHANGELOG.md

@@ -27,7 +27,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- [BugSnag] BREAKING CHANGE: Rename Insight Hub tool to BugSnag, following rebranding. Configuration variables `INSIGHT_HUB_AUTH_TOKEN` and `INSIGHT_HUB_PROJECT_API_KEY` need to be updated to `BUGSNAG_AUTH_TOKEN` and `BUGSNAG_PROJECT_API_KEY` after upgrade. [#101](https://github.com/SmartBear/smartbear-mcp/pull/101)
+- [BugSnag] BREAKING CHANGE: Rename Insight Hub tool to BugSnag, following rebranding. Configuration variables `INSIGHT_HUB_AUTH_TOKEN`, `INSIGHT_HUB_PROJECT_API_KEY` and `INSIGHT_HUB_ENDPOINT` need to be updated to `BUGSNAG_AUTH_TOKEN`, `BUGSNAG_PROJECT_API_KEY` and `BUGSNAG_ENDPOINT` after upgrade. [#101](https://github.com/SmartBear/smartbear-mcp/pull/101)
 - [BugSnag] Remove API links from API responses [#110](https://github.com/SmartBear/smartbear-mcp/pull/110)
 
 ## [0.4.0] - 2025-08-26

CONTRIBUTING.md

@@ -5,7 +5,9 @@ Thank you for your contributing to SmartBear MCP!
 - [Contributing](#contributing)
   - [Getting Started](#getting-started)
     - [Repository Structure](#repository-structure)
+    - [Branching Strategy](#branching-strategy)
   - [Development Setup](#development-setup)
+  - [Making Changes](#making-changes)
   - [Testing Guidelines](#testing-guidelines)
     - [Test Requirements](#test-requirements)
     - [Running Tests](#running-tests)
@@ -18,19 +20,35 @@ Thank you for your contributing to SmartBear MCP!
 ### Repository Structure
 
 ```
-├── src/api-hub/      # API Hub integration
-├── src/bugsnag/      # BugSnag integration
-├── src/pactflow/     # PactFlow integration
-├── src/reflect/      # Reflect integration
-├── src/common/       # Shared utilities and types
-├── src/tests/        # Test files
-├── docs/             # Documentation
-└── scripts/          # Build and utility scripts
+├── src/<product-name>/      # Specific SmartBear product integration
+├── src/common/              # Shared utilities and types
+├── src/tests/               # Test files
+├── docs/                    # Documentation for developer.smartbear.com site
+└── scripts/                 # Build and utility scripts
 ```
 
+### Branching Strategy
+
+Releases are automatically deployed on merge to `main` (see [below](#releases)), so in order to coordinate a release between the various products a `next` branch is used to accumulate changes and avoid unintentionally releasing part changes.
+
+Please read the following guidance:
+
+- Feature branches should be created from `next` and PRs made into `next`
+- If your change is noteworthy to our customers, update the [CHANGELOG.md](./CHANGELOG.md) in your PR with details of your changes
+  - You may need to create a new section if your change is the first since the last release
+- This is a public repo, so consider a squash-commit of your feature PRs to give a cleaner history
+- Create `integration/` branches from `next` if you want to keep a larger change away from the release during development
+- Don't forget to update the `docs/` directory with any noteworthy changes to functionality or configuration
+
 ## Development Setup
 
-1. **Install Dependencies**
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/SmartBear/smartbear-mcp.git
+   cd smartbear-mcp
+   ```
+
+2. **Install Dependencies**
 
   Make sure you have a current version of Node.js and then run:
 
@@ -51,6 +69,46 @@ Thank you for your contributing to SmartBear MCP!
    npm run test:run
    ```
 
+## Making Changes
+
+To build the files for local testing, run:
+
+```bash
+npm run build
+```
+
+You can then add the `dist` directory as an MCP server in your IDE.
+
+For example, in VS Code, use the following configuration with debugging enabled so that you can step through your code:
+
+```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": {
+        // ...
+      }
+    }
+    // ...
+  },
+}
+```
+
+You can also use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) web interface, first setting the appropriate environment variables for the products you want to test:
+
+```bash
+npx @modelcontextprotocol/inspector node dist/index.js
+```
+
 ## Testing Guidelines
 
 ### Test Requirements
@@ -78,6 +136,10 @@ Documentation lives in the `/docs` directory of this repo. Changes to the docume
 
 ## Releases
 
+A release will be carried out by a member of the SmartBear team when a set of releasable changes is ready on the `next` branch. If there are commits from more than one product, the releasing engineer will coordinate with each product team to ensure the release is appropriate and sufficiently documented in the changelog/docs.
+
+Please follow these steps to create a new release:
+
 1. **Decide on a version number**
     - Check the changes in `CHANGELOG.md` and using [semantic versioning](https://semver.org/), decide on a new version. i.e. `1.2.3`
 
@@ -97,6 +159,10 @@ Documentation lives in the `/docs` directory of this repo. Changes to the docume
     - Create a new Github release with the version you decided on earlier
     - Changes will be automatically deployed once the Github release is created
 
+5. **Post-Release**
+    - A PR should automatically be created to merge `main` back into `next`, this should be merged down soon after release
+    - Check https://developer.smartbear.com/smartbear-mcp/ to ensure the docs have been updated correctly
+
 Please ensure you update internal ticketing systems accordingly.
 
 ## Additional Resources

README.md

@@ -165,113 +165,7 @@ For detailed introduction, examples, and advanced configuration visit our 📖 [
 
 ## 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:**
-   ```bash
-   git clone https://github.com/SmartBear/smartbear-mcp.git
-   cd smartbear-mcp
-   ```
-
-2. **Install dependencies:**
-   ```bash
-   npm install
-   ```
-
-3. **Build the server:**
-   ```bash
-   npm run build
-   ```
-
-4. **Add the server to your IDE** configuration updating `.vscode/mcp.json` (or equivalent) to point to your local build
-
-    <details>
-    <summary><strong>📋 VSCode (mcp.json)</strong></summary>
-
-    ```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": {
-            "BUGSNAG_AUTH_TOKEN": "${input:bugsnag_auth_token}",
-            "BUGSNAG_PROJECT_API_KEY": "${input:bugsnag_project_api_key}",
-            "REFLECT_API_TOKEN": "${input:reflect_api_token}",
-            "API_HUB_API_KEY": "${input:api_hub_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}"
-          }
-        }
-      },
-      "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": "api_hub_api_key",
-          "type": "promptString",
-          "description": "API Hub API Key - leave blank to disable API Hub tools",
-          "password": true
-        },
-        {
-          "id": "pact_broker_base_url",
-          "type": "promptString",
-          "description": "PactFlow or Pact Broker base url - leave blank to disable PactFlow 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
-        },
-      ]
-    }
-    ```
-    </details>
-
-5. **Local testing** using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) web interface:
-
-    ```bash
-    BUGSNAG_AUTH_TOKEN="your_token" REFLECT_API_TOKEN="your_reflect_token" API_HUB_API_KEY="your_api_hub_key" PACT_BROKER_BASE_URL="your-pactflow-url" PACT_BROKER_TOKEN="your-pactflow-token" PACT_BROKER_USERNAME="your-pact-broker-username" PACT_BROKER_PASSWORD="your-pact-broker-password" npx @modelcontextprotocol/inspector npx @smartbear/mcp@latest
-    ```
+For developers who want to contribute to the SmartBear MCP server, please see the [CONTRIBUTING.md](CONTRIBUTING.md) guide.
 
 ## License
 

docs/products/SmartBear MCP Server/bugsnag-integration.md

@@ -56,3 +56,4 @@ Refers to an occurrence of an error: `bugsnag://event/{id}`.
     -   Project event filters are pre-cached for better performance
 -   **Filtering**: Use `get_project_event_filters` to discover available filter fields before using `list_bugsnag_project_errors`
 -   **Time Filters**: Support both relative format (e.g., `7d`, `24h`) and ISO 8601 UTC format (e.g., `2018-05-20T00:00:00Z`)
+-   **On-Premise Support**: Set the `BUGSNAG_ENDPOINT` environment variable to your custom endpoint if you're using an on-premise installation of BugSnag.