Merge pull request #41 from rollbar/brianr/user-agent-dynamic-version

brianr · web-flow · commit cf74fa3a1cfa · 2025-08-19T12:35:18.000-07:00
User agent: dynamic version, add tool name
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,6 +41,8 @@ jobs:
 
     - name: Run tests with coverage
       run: npm run test:coverage
+      env:
+        ROLLBAR_ACCESS_TOKEN: not-a-token
 
     - name: Run end-to-end tests
       run: npm run test:e2e
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rollbar/mcp-server",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Model Context Protocol server for Rollbar",
   "repository": {
     "type": "git",
diff --git a/src/config.ts b/src/config.ts
@@ -1,11 +1,14 @@
 import dotenv from "dotenv";
+import packageJson from "../package.json" with { type: "json" };
 
 // Load environment variables from .env file
 // `quiet: true` to prevent logging to stdio which disrupts some mcp clients
 dotenv.config({ quiet: true });
 
 export const ROLLBAR_API_BASE = "https://api.rollbar.com/api/1";
-export const USER_AGENT = "rollbar-mcp-server/0.0.1";
+export function getUserAgent(toolName: string): string {
+  return `rollbar-mcp-server/${packageJson.version} (tool: ${toolName})`;
+}
 export const ROLLBAR_ACCESS_TOKEN = process.env.ROLLBAR_ACCESS_TOKEN;
 
 if (!ROLLBAR_ACCESS_TOKEN) {
diff --git a/src/tools/get-deployments.ts b/src/tools/get-deployments.ts
@@ -16,10 +16,9 @@ export function registerGetDeploymentsTool(server: McpServer) {
     },
     async ({ limit }) => {
       const deploysUrl = `${ROLLBAR_API_BASE}/deploys?limit=${limit}`;
-      const deploysResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarDeployResponse>>(
-          deploysUrl,
-        );
+      const deploysResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarDeployResponse>
+      >(deploysUrl, "get-deployments");
 
       if (deploysResponse.err !== 0) {
         const errorMessage =
diff --git a/src/tools/get-item-details.ts b/src/tools/get-item-details.ts
@@ -27,10 +27,9 @@ export function registerGetItemDetailsTool(server: McpServer) {
     async ({ counter, max_tokens }) => {
       // Redirects are followed, so we get an item response from the counter request
       const counterUrl = `${ROLLBAR_API_BASE}/item_by_counter/${counter}`;
-      const itemResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarItemResponse>>(
-          counterUrl,
-        );
+      const itemResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarItemResponse>
+      >(counterUrl, "get-item-details");
 
       if (itemResponse.err !== 0) {
         const errorMessage =
@@ -41,10 +40,9 @@ export function registerGetItemDetailsTool(server: McpServer) {
       const item = itemResponse.result;
 
       const occurrenceUrl = `${ROLLBAR_API_BASE}/instance/${item.last_occurrence_id}`;
-      const occurrenceResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarOccurrenceResponse>>(
-          occurrenceUrl,
-        );
+      const occurrenceResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarOccurrenceResponse>
+      >(occurrenceUrl, "get-item-details");
 
       if (occurrenceResponse.err !== 0) {
         // We got the item but failed to get occurrence. Return just the item data.
diff --git a/src/tools/get-top-items.ts b/src/tools/get-top-items.ts
@@ -16,10 +16,9 @@ export function registerGetTopItemsTool(server: McpServer) {
     },
     async ({ environment }) => {
       const reportUrl = `${ROLLBAR_API_BASE}/reports/top_active_items?hours=24&environments=${environment}&sort=occurrences`;
-      const reportResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarTopItemResponse>>(
-          reportUrl,
-        );
+      const reportResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarTopItemResponse>
+      >(reportUrl, "get-top-items");
 
       if (reportResponse.err !== 0) {
         const errorMessage =
diff --git a/src/tools/get-version.ts b/src/tools/get-version.ts
@@ -17,10 +17,9 @@ export function registerGetVersionTool(server: McpServer) {
     },
     async ({ version, environment }) => {
       const versionsUrl = `${ROLLBAR_API_BASE}/versions/${version}?environment=${environment}`;
-      const versionsResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarVersionsResponse>>(
-          versionsUrl,
-        );
+      const versionsResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarVersionsResponse>
+      >(versionsUrl, "get-version");
 
       if (versionsResponse.err !== 0) {
         const errorMessage =
diff --git a/src/tools/list-items.ts b/src/tools/list-items.ts
@@ -82,10 +82,9 @@ export function registerListItemsTool(server: McpServer) {
 
       const listUrl = `${ROLLBAR_API_BASE}/items/?${params.toString()}`;
 
-      const listResponse =
-        await makeRollbarRequest<RollbarApiResponse<RollbarListItemsResponse>>(
-          listUrl,
-        );
+      const listResponse = await makeRollbarRequest<
+        RollbarApiResponse<RollbarListItemsResponse>
+      >(listUrl, "list-items");
 
       if (listResponse.err !== 0) {
         const errorMessage =
diff --git a/src/tools/update-item.ts b/src/tools/update-item.ts
@@ -69,6 +69,7 @@ export function registerUpdateItemTool(server: McpServer) {
       const url = `${ROLLBAR_API_BASE}/item/${itemId}`;
       const response = await makeRollbarRequest<RollbarApiResponse<unknown>>(
         url,
+        "update-item",
         {
           method: "PATCH",
           headers: {
diff --git a/src/utils/api.ts b/src/utils/api.ts
@@ -1,16 +1,17 @@
-import { ROLLBAR_ACCESS_TOKEN, USER_AGENT } from "../config.js";
+import { ROLLBAR_ACCESS_TOKEN, getUserAgent } from "../config.js";
 
 // Helper function for making Rollbar API requests
 export async function makeRollbarRequest<T>(
   url: string,
+  toolName: string,
   options?: RequestInit,
 ): Promise<T> {
   if (!ROLLBAR_ACCESS_TOKEN) {
     throw new Error("ROLLBAR_ACCESS_TOKEN environment variable is not set");
   }
 
   const headers = {
-    "User-Agent": USER_AGENT,
+    "User-Agent": getUserAgent(toolName),
     "X-Rollbar-Access-Token": ROLLBAR_ACCESS_TOKEN,
     Accept: "application/json",
     ...options?.headers,
diff --git a/tests/unit/config.test.ts b/tests/unit/config.test.ts
@@ -0,0 +1,40 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+describe('config utilities', () => {
+  let getUserAgent: any;
+
+  beforeEach(async () => {
+    vi.resetModules();
+    
+    // Mock the package.json import
+    vi.doMock('../../src/package.json', () => ({
+      version: '0.2.3'
+    }));
+
+    const configModule = await import('../../src/config.js');
+    getUserAgent = configModule.getUserAgent;
+  });
+
+  describe('getUserAgent', () => {
+    it('should generate correct user agent string with tool name', () => {
+      const userAgent = getUserAgent('get-item-details');
+      expect(userAgent).toBe('rollbar-mcp-server/0.2.3 (tool: get-item-details)');
+    });
+
+    it('should handle different tool names', () => {
+      expect(getUserAgent('list-items')).toBe('rollbar-mcp-server/0.2.3 (tool: list-items)');
+      expect(getUserAgent('update-item')).toBe('rollbar-mcp-server/0.2.3 (tool: update-item)');
+      expect(getUserAgent('get-version')).toBe('rollbar-mcp-server/0.2.3 (tool: get-version)');
+      expect(getUserAgent('get-deployments')).toBe('rollbar-mcp-server/0.2.3 (tool: get-deployments)');
+      expect(getUserAgent('get-top-items')).toBe('rollbar-mcp-server/0.2.3 (tool: get-top-items)');
+    });
+
+    it('should handle tool names with special characters', () => {
+      expect(getUserAgent('custom-tool-123')).toBe('rollbar-mcp-server/0.2.3 (tool: custom-tool-123)');
+    });
+
+    it('should handle empty string tool name', () => {
+      expect(getUserAgent('')).toBe('rollbar-mcp-server/0.2.3 (tool: )');
+    });
+  });
+});
diff --git a/tests/unit/config.vitest.test.ts b/tests/unit/config.vitest.test.ts
@@ -30,9 +30,9 @@ describe('config', () => {
     expect(ROLLBAR_API_BASE).toBe('https://api.rollbar.com/api/1');
   });
 
-  it('should have correct user agent', async () => {
-    const { USER_AGENT } = await import('../../src/config.js');
-    expect(USER_AGENT).toBe('rollbar-mcp-server/0.0.1');
+  it('should have getUserAgent function that generates correct user agent string', async () => {
+    const { getUserAgent } = await import('../../src/config.js');
+    expect(getUserAgent('test-tool')).toBe('rollbar-mcp-server/0.2.3 (tool: test-tool)');
   });
 
   it('should load access token from environment', async () => {
diff --git a/tests/unit/tools/get-deployments.test.ts b/tests/unit/tools/get-deployments.test.ts
@@ -52,7 +52,8 @@ describe('get-deployments tool', () => {
     const result = await toolHandler({ limit: 10 });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/deploys?limit=10'
+      'https://api.rollbar.com/api/1/deploys?limit=10',
+      'get-deployments'
     );
     expect(result.content[0].type).toBe('text');
     expect(result.content[0].text).toContain('"environment": "production"');
@@ -77,7 +78,8 @@ describe('get-deployments tool', () => {
     const result = await toolHandler({ limit: 20 });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/deploys?limit=20'
+      'https://api.rollbar.com/api/1/deploys?limit=20',
+      'get-deployments'
     );
   });
 
diff --git a/tests/unit/tools/get-item-details.test.ts b/tests/unit/tools/get-item-details.test.ts
@@ -74,10 +74,12 @@ describe('get-item-details tool', () => {
     const result = await toolHandler({ counter: 42 });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/item_by_counter/42'
+      'https://api.rollbar.com/api/1/item_by_counter/42',
+      'get-item-details'
     );
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/instance/999'
+      'https://api.rollbar.com/api/1/instance/999',
+      'get-item-details'
     );
     
     const responseData = JSON.parse(result.content[0].text);
diff --git a/tests/unit/tools/get-top-items.test.ts b/tests/unit/tools/get-top-items.test.ts
@@ -52,7 +52,8 @@ describe('get-top-items tool', () => {
     const result = await toolHandler({ environment: 'staging' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=staging&sort=occurrences'
+      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=staging&sort=occurrences',
+      'get-top-items'
     );
     expect(result.content[0].type).toBe('text');
     expect(result.content[0].text).toContain('"id": 1');
@@ -65,7 +66,8 @@ describe('get-top-items tool', () => {
     const result = await toolHandler({ environment: 'production' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=production&sort=occurrences'
+      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=production&sort=occurrences',
+      'get-top-items'
     );
   });
 
@@ -129,7 +131,8 @@ describe('get-top-items tool', () => {
     await toolHandler({ environment: 'development' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=development&sort=occurrences'
+      'https://api.rollbar.com/api/1/reports/top_active_items?hours=24&environments=development&sort=occurrences',
+      'get-top-items'
     );
   });
 });
diff --git a/tests/unit/tools/get-version.test.ts b/tests/unit/tools/get-version.test.ts
@@ -53,7 +53,8 @@ describe('get-version tool', () => {
     const result = await toolHandler({ version: 'v1.2.3', environment: 'staging' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/versions/v1.2.3?environment=staging'
+      'https://api.rollbar.com/api/1/versions/v1.2.3?environment=staging',
+      'get-version'
     );
     expect(result.content[0].type).toBe('text');
     expect(result.content[0].text).toContain('"version": "v1.2.3"');
@@ -66,7 +67,8 @@ describe('get-version tool', () => {
     const result = await toolHandler({ version: 'abc123', environment: 'production' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/versions/abc123?environment=production'
+      'https://api.rollbar.com/api/1/versions/abc123?environment=production',
+      'get-version'
     );
   });
 
@@ -141,7 +143,8 @@ describe('get-version tool', () => {
     await toolHandler({ version: 'git-sha-abc123', environment: 'development' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/versions/git-sha-abc123?environment=development'
+      'https://api.rollbar.com/api/1/versions/git-sha-abc123?environment=development',
+      'get-version'
     );
   });
 });
diff --git a/tests/unit/tools/list-items.test.ts b/tests/unit/tools/list-items.test.ts
@@ -56,7 +56,8 @@ describe('list-items tool', () => {
     const result = await toolHandler({ status: 'active', environment: 'production' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/items/?status=active&environment=production'
+      'https://api.rollbar.com/api/1/items/?status=active&environment=production',
+      'list-items'
     );
     
     const responseData = JSON.parse(result.content[0].text);
@@ -86,7 +87,8 @@ describe('list-items tool', () => {
     });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/items/?status=resolved&level=error&level=critical&environment=staging&page=2&q=TypeError'
+      'https://api.rollbar.com/api/1/items/?status=resolved&level=error&level=critical&environment=staging&page=2&q=TypeError',
+      'list-items'
     );
     
     const responseData = JSON.parse(result.content[0].text);
@@ -104,7 +106,8 @@ describe('list-items tool', () => {
     await toolHandler({ page: 1, status: 'active', environment: 'production' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/items/?status=active&environment=production'
+      'https://api.rollbar.com/api/1/items/?status=active&environment=production',
+      'list-items'
     );
   });
 
@@ -185,7 +188,8 @@ describe('list-items tool', () => {
     await toolHandler({ level: [], status: 'active', environment: 'production' });
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
-      'https://api.rollbar.com/api/1/items/?status=active&environment=production'
+      'https://api.rollbar.com/api/1/items/?status=active&environment=production',
+      'list-items'
     );
   });
 
diff --git a/tests/unit/tools/update-item.test.ts b/tests/unit/tools/update-item.test.ts
@@ -67,6 +67,7 @@ describe('update-item tool', () => {
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
       'https://api.rollbar.com/api/1/item/123',
+      'update-item',
       {
         method: 'PATCH',
         headers: {
@@ -99,6 +100,7 @@ describe('update-item tool', () => {
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
       'https://api.rollbar.com/api/1/item/456',
+      'update-item',
       {
         method: 'PATCH',
         headers: {
@@ -174,6 +176,7 @@ describe('update-item tool', () => {
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
       'https://api.rollbar.com/api/1/item/123',
+      'update-item',
       {
         method: 'PATCH',
         headers: {
@@ -252,6 +255,7 @@ describe('update-item tool', () => {
 
     expect(makeRollbarRequestMock).toHaveBeenCalledWith(
       'https://api.rollbar.com/api/1/item/123',
+      'update-item',
       {
         method: 'PATCH',
         headers: {
diff --git a/tests/unit/utils/api.test.ts b/tests/unit/utils/api.test.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@rollbar/mcp-server",`
`3`		`- "version": "0.2.2",`
	`3`	`+ "version": "0.2.3",`
`4`	`4`	`"description": "Model Context Protocol server for Rollbar",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ export function registerUpdateItemTool(server: McpServer) {`
`69`	`69`	const url = `${ROLLBAR_API_BASE}/item/${itemId}`;
`70`	`70`	`const response = await makeRollbarRequest<RollbarApiResponse<unknown>>(`
`71`	`71`	`url,`
	`72`	`+ "update-item",`
`72`	`73`	`{`
`73`	`74`	`method: "PATCH",`
`74`	`75`	`headers: {`