Minor fixes (#21)

Author: SketchingDev

README.md

@@ -7,7 +7,7 @@ A Model Context Protocol (MCP) server for Genesys Cloud's Platform API.
 
 ## Tools Overview
 
-An overview of the tools that this MPC server makes available. Read more about each specific tool
+An overview of the tools that this MCP server makes available. Read more about each specific tool
 in the [tools doc](/docs/tools.md).
 
 | Tool                                                                          | Description                                                              |
@@ -23,7 +23,7 @@ in the [tools doc](/docs/tools.md).
 
 ## Authentication
 
-This currently only a supports stdio Server. To configure authentication you'll need to:
+This currently only supports a stdio server. To configure authentication you'll need to:
 
 1. Create an OAuth Client in Genesys Cloud
 2. Assign the permissions to it for the tools you want to be used
@@ -43,6 +43,6 @@ npm run dev
 ## Under active development
 
 This is part of [personal project](https://www.linkedin.com/posts/lucas-woodward-the-dev_genesys-genesyscloud-vertexai-activity-7321306518908280833-cWt8?utm_source=share&utm_medium=member_desktop&rcm=ACoAABsbo2wBcmnNqxYJ5UO9BrsfURZcVEtgLOU)
-to create a conversational Business Insights tool. It is a practical way for my to learn MCP servers, and how best to represent Genesys Cloud's Platform APIs in a way that can be easily consumed by LLMs.
+to create a conversational Business Insights tool. It is a practical way for me to learn MCP servers, and how best to represent Genesys Cloud's Platform APIs in a way that can be easily consumed by LLMs.
 
 There will be a lot of changes, and I will be sure to [share my learnings in my newsletter](https://makingchatbots.com/).

docs/tools.md

@@ -15,7 +15,7 @@ or listing available queues.
 ### Inputs
 
 - `name`
-  - The name (or partial name) of the routing queue(s) to search for. Wildcards ('_') are supported for pattern matching (e.g., 'Support_', '*Emergency', '*Sales*'). Use '*' alone to retrieve all queues
+  - The name (or partial name) of the routing queue(s) to search for. Wildcards ('\*') are supported for pattern matching (e.g., 'Support\*', '\*Emergency', '\*Sales\*'). Use '\*' alone to retrieve all queues
 - `pageNumber`
   - The page number of the results to retrieve, starting from 1. Defaults to 1 if not specified. Used with 'pageSize' for navigating large result sets
 - `pageSize`
@@ -180,7 +180,7 @@ Searches for voice conversations within a specified time window, optionally filt
 - `pageNumber`
   - The page number of the results to retrieve, starting from 1. Defaults to 1 if not specified. Used with 'pageSize' for navigating large result sets
 - `pageSize`
-  - The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500
+  - The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 100
 - `startDate`
   - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z')
 - `endDate`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@makingchatbots/genesys-cloud-mcp-server",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "A Model Context Protocol (MCP) server exposing Genesys Cloud tools for LLMs, including sentiment analysis, conversation search, topic detection and more.",
   "exports": "./dist/index.js",
   "type": "module",

src/tools/conversationTranscription/conversationTranscription.ts

@@ -75,36 +75,27 @@ function isNonHuman(participant: Participant | undefined) {
   );
 }
 
-function isInternalParticipant(participant: Participant) {
-  if (participant.participantPurpose) {
-    return (
-      participant.participantPurpose.toLowerCase() === "user" ||
-      participant.participantPurpose.toLowerCase() === "agent" ||
-      isNonHuman(participant)
-    );
-  } else if (
-    participant.participantPurpose &&
-    participant.participantPurpose.toLowerCase() === "internal"
-  ) {
-    return !!participant.userId;
+function isInternalParticipant(participant: Participant): boolean {
+  const purpose = participant.participantPurpose?.toLowerCase();
+  if (!purpose) {
+    return false;
   }
-  return false;
+
+  return (
+    purpose === "user" ||
+    purpose === "agent" ||
+    purpose === "internal" ||
+    isNonHuman(participant)
+  );
 }
 
-function isExternalParticipant(participant: Participant) {
-  if (participant.participantPurpose) {
-    return (
-      participant.participantPurpose.toLowerCase() === "external" ||
-      participant.participantPurpose.toLowerCase() === "customer" ||
-      !isNonHuman(participant)
-    );
-  } else if (
-    participant.participantPurpose &&
-    participant.participantPurpose.toLowerCase() === "external"
-  ) {
-    return true;
+function isExternalParticipant(participant: Participant): boolean {
+  const purpose = participant.participantPurpose?.toLowerCase();
+  if (!purpose) {
+    return false;
   }
-  return false;
+
+  return purpose === "external" || purpose === "customer";
 }
 
 const paramsSchema = z.object({
@@ -164,16 +155,16 @@ export const conversationTranscription: ToolFactory<
       // 2. Download recordings
       const transcriptionsForRecordings: TranscriptResponseFormat[] = [];
 
-      for (const recodingSessionId of recordingSessionIds) {
-        if (!recodingSessionId) {
+      for (const recordingSessionId of recordingSessionIds) {
+        if (!recordingSessionId) {
           continue;
         }
         let transcriptUrl: Models.TranscriptUrl | null = null;
         try {
           transcriptUrl =
             await speechTextAnalyticsApi.getSpeechandtextanalyticsConversationCommunicationTranscripturl(
               conversationId,
-              recodingSessionId,
+              recordingSessionId,
             );
         } catch (error) {
           const message = isUnauthorisedError(error)

src/tools/sampleConversationsByQueue/sampleConversationsByQueue.ts

@@ -99,8 +99,6 @@ export const sampleConversationsByQueue: ToolFactory<
             await analyticsApi.getAnalyticsConversationsDetailsJob(jobId);
           state = jobStatus.state ?? "UNKNOWN";
 
-          console.log("UPDATE", { attempts, state });
-
           if (state === "FULFILLED") break;
 
           switch (jobStatus.state) {

src/tools/sampleConversationsByQueue/sampleEvenly.test.ts

@@ -0,0 +1,16 @@
+import { describe, expect, test } from "vitest";
+import { sampleEvenly } from "./sampleEvenly.js";
+
+describe("sampleEvenly", () => {
+  test("returns evenly distributed items when sample size is less than list length", () => {
+    const list = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+    const result = sampleEvenly(list, 4);
+    expect(result).toStrictEqual([1, 3, 6, 8]);
+  });
+
+  test("returns original list when sample size is greater than or equal to list length", () => {
+    const list = [1, 2, 3, 4];
+    expect(sampleEvenly(list, 4)).toStrictEqual(list);
+    expect(sampleEvenly(list, 5)).toStrictEqual(list);
+  });
+});

src/tools/searchQueues.ts

@@ -23,7 +23,7 @@ function formatQueues(
     pageNumber?: number;
     pageSize?: number;
     pageCount?: number;
-    total?: number;
+    totalHits?: number;
   },
 ) {
   const queueItems = queues.flatMap((q) => [
@@ -35,8 +35,13 @@ function formatQueues(
       : []),
   ]);
 
+  const firstLine =
+    pagination.totalHits !== undefined
+      ? `Found ${String(pagination.totalHits)} queues matching "${inputQueueName}":`
+      : `Found the following queues matching "${inputQueueName}":`;
+
   return [
-    `Found the following queues matching "${inputQueueName}":`,
+    firstLine,
     ...queueItems,
     "",
     ...paginationSection("Total Matching Queues", pagination),
@@ -129,7 +134,7 @@ export const searchQueues: ToolFactory<
               pageNumber: result.pageNumber,
               pageSize: result.pageSize,
               pageCount: result.pageCount,
-              total: result.total,
+              totalHits: result.total,
             }),
           },
         ],

src/tools/searchVoiceConversations.test.ts

@@ -63,7 +63,7 @@ describe("Search Voice Conversations Tool", () => {
           },
           pageSize: {
             description:
-              "The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500",
+              "The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 100",
             exclusiveMinimum: 0,
             maximum: 100,
             type: "integer",
@@ -130,6 +130,30 @@ describe("Search Voice Conversations Tool", () => {
     });
   });
 
+  test("fails when startDate is after endDate", async () => {
+    toolDeps.analyticsApi.postAnalyticsConversationsDetailsQuery.mockResolvedValue(
+      { conversations: [] },
+    );
+
+    await expect(
+      client.callTool({
+        name: toolName,
+        arguments: {
+          startDate: "2024-01-02T00:00:00Z",
+          endDate: "2024-01-01T00:00:00Z",
+        },
+      }),
+    ).resolves.toStrictEqual({
+      isError: true,
+      content: [
+        {
+          type: "text",
+          text: "Start date must be before end date.",
+        },
+      ],
+    });
+  });
+
   test("error from Genesys Cloud's Platform SDK returned", async () => {
     toolDeps.analyticsApi.postAnalyticsConversationsDetailsQuery.mockRejectedValue(
       new Error("Test Error Message"),

src/tools/searchVoiceConversations.ts

@@ -56,7 +56,7 @@ const paramsSchema = z.object({
     .max(100)
     .optional()
     .describe(
-      "The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500",
+      "The maximum number of conversations to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 100",
     ),
   startDate: z
     .string()

src/tools/utils/paginationSection.test.ts

@@ -22,7 +22,7 @@ const testCases: {
     ],
   },
   {
-    name: "",
+    name: "Missing total hits",
     input: {
       pageSize: 100,
       pageNumber: 1,
@@ -36,7 +36,7 @@ const testCases: {
     ],
   },
   {
-    name: "",
+    name: "Divisible hit count",
     input: {
       pageSize: 100,
       pageNumber: 1,