feat: attachments (#2)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: bobbyg603

.github/workflows/test.yml

@@ -29,4 +29,7 @@ jobs:
     - name: Run tests
       run: npm test
       env:
-        CI: true 
+        CI: true 
+        BUGSPLAT_DATABASE: ${{ secrets.BUGSPLATDATABASE }}
+        BUGSPLAT_CLIENT_ID: ${{ secrets.BUGSPLATCLIENTID }}
+        BUGSPLAT_CLIENT_SECRET: ${{ secrets.BUGSPLATCLIENTSECRET }} 

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
   "jasmineExplorer.nodeArgv": [
+    "-r",
+    "dotenv/config",
     "--enable-source-maps",
     "--experimental-vm-modules"
   ],

README.md

@@ -4,21 +4,14 @@ This is a prototype implementation of a Model Context Protocol (MCP) server for
 
 ## Getting Started 👨‍🏫
 
-1. Install `bugsplat-mcp` globally with npm:
-```bash
-npm i -g bugsplat-mcp
-```
-
-2. Add a local MCP server to [Claude Desktop](https://claude.ai/download) via `Settings > Developer > Edit Config`. Add the path to `npx` under `command` and the path to `bugsplat-mcp` under `args`. Finally add env values for `BUGSPLAT_DATABASE`, `BUGSPLAT_CLIENT_ID`, and `BUGSPLAT_CLIENT_SECRET`.
+1. Add a local MCP server to [Claude Desktop](https://claude.ai/download) via `Settings > Developer > Edit Config`. Add the path to `npx` under `command` and `-y`, `bugsplat-mcp@latest` under `args`. Finally add env values for `BUGSPLAT_DATABASE`, `BUGSPLAT_CLIENT_ID`, and `BUGSPLAT_CLIENT_SECRET`.
 ```json
 {
   "mcpServers": {
     ...
     "bugsplat-mcp": {
       "command": "npx",
-      "args": [
-        "bugsplat-mcp"
-      ],
+      "args": ["-y", "bugsplat-mcp@latest"],
       "env": {
         "BUGSPLAT_DATABASE": "fred",
         "BUGSPLAT_CLIENT_ID": "***",
@@ -29,34 +22,43 @@ npm i -g bugsplat-mcp
 }
 ```
 
-3. Open Claude and ask about BugSplat.
+2. Open Claude and ask about BugSplat.
 
 ## Available Tools 🧰
 
 The server provides the following tools for interacting with BugSplat:
 
-### get-issues
-Get a list of BugSplat issues with optional filtering:
-- `application`: Filter by application name
-- `version`: Filter by version
-- `stackGroup`: Filter by stack frame the crash is grouped by
-- `startDate`: Filter by start date (ISO format)
-- `endDate`: Filter by end date (ISO format)
-- `pageSize`: Number of results per page (1-99, defaults to 50)
+### list-issues
+List BugSplat issues with optional filtering. The issues tool lists all crashes in the BugSplat database and is useful for determining the most recent crashes.
+- `application`: Application name to filter by
+- `version`: Version to filter by
+- `stackGroup`: Stack group to filter by
+- `startDate`: Start date for filtering (ISO format)
+- `endDate`: End date for filtering (ISO format)
+- `pageSize`: Number of results per page (1-100, defaults to 10)
 
 ### get-issue
-Get detailed information about a specific issue:
-- `id`: The issue ID to retrieve
+Get details of a specific BugSplat issue. The issue tool lists the details of a specific crash and is useful for determining the cause of and fixing a specific crash.
+- `id`: Issue ID to retrieve
 
 ### get-summary
-Get a summary of BugSplat issues with optional filtering:
+Get summary of BugSplat issues with optional filtering. The summary tool lists information about groups of crashes and is useful for determining what issues are most prevalent.
 - `applications`: Array of application names to filter by
 - `versions`: Array of versions to filter by
-- `startDate`: Filter by start date (ISO format)
-- `endDate`: Filter by end date (ISO format)
+- `startDate`: Start date for filtering (ISO format)
+- `endDate`: End date for filtering (ISO format)
 - `pageSize`: Number of results per page (1-20, defaults to 10)
 
-Each tool will automatically use the credentials provided in your `.env` file. 
+### list-attachments
+Get list of attachments for a specific BugSplat issue. The attachments tool lists the attachments (log files, screenshots, etc.) for a specific crash and is useful for determining the cause of and fixing a specific crash.
+- `id`: Issue ID to retrieve
+
+### get-attachment
+Get a specific attachment for a BugSplat issue. Returns the file content as a base64 blob.
+- `crashId`: The ID of the crash report
+- `file`: The name of the attachment file to retrieve
+
+Each tool will automatically use the credentials provided in your `.env` file or the environment variables configured for the MCP server. 
 
 ## Developing 👨‍💻