Update docs

README.md

@@ -17,6 +17,7 @@ in the [tools doc](/docs/tools.md).
 | [Sample Conversations By Queue](/docs/tools.md#sample-conversations-by-queue) | Retrieves a representative sample of Conversation IDs for a Queue ID     |
 | [Voice Call Quality](/docs/tools.md#voice-call-quality)                       | Retrieves voice call quality metrics for one or more conversations by ID |
 | [Conversation Sentiment](/docs/tools.md#conversation-sentiment)               | Retrieves the sentiment for one or more conversations by ID              |
+| [Conversation Topics](/docs/tools.md#conversation-topics)                     | Retrieves the topics for a conversation by ID                            |
 
 ## Authentication
 

docs/tools.md

@@ -2,6 +2,8 @@
 
 ## Search Queues
 
+**Tool name:** `search_queues`
+
 Searches for routing queues based on their name, allowing for wildcard searches. Returns a paginated
 list of matching queues, including their Name, ID, Description (if available), and Member Count
 (if available). Also provides pagination details like current page, page size, total results found,
@@ -13,11 +15,11 @@ 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.
+  - 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 queues to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500.
+  - The maximum number of queues to return per page. Defaults to 100 if not specified. Used with 'pageNumber' for pagination. The maximum value is 500
 
 ### Security
 
@@ -31,19 +33,20 @@ Platform API endpoint used:
 
 ## Query Queue Volumes
 
-Returns a breakdown of how many conversations occurred in each specified queue between two
-dates. Useful for comparing workload across queues.
+**Tool name:** `query_queue_volumes`
+
+Returns a breakdown of how many conversations occurred in each specified queue between two dates. Useful for comparing workload across queues.
 
 [Source file](/src/tools/queryQueueVolumes.ts).
 
 ### Inputs
 
 - `queueIds`
-  - The IDs of the queues to filter conversations by. Max 300.
+  - List of up to 300 queue IDs to filter conversations by
 - `startDate`
-  - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
+  - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z')
 - `endDate`
-  - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
+  - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z')
 
 ### Security
 
@@ -59,17 +62,18 @@ Platform API endpoints used:
 
 ## Sample Conversations By Queue
 
-Retrieves conversation analytics for a specific queue between two dates, returning a
-representative sample of conversation IDs. Useful for reporting, investigation, or summarisation.
+**Tool name:** `sample_conversations_by_queue`
+
+Retrieves conversation analytics for a specific queue between two dates, returning a representative sample of conversation IDs. Useful for reporting, investigation, or summarisation.
 
 ### Inputs
 
 - `queueId`
-  - The ID of the queue to filter conversations by.
+  - The UUID ID of the queue to filter conversations by. (e.g., 00000000-0000-0000-0000-000000000000)
 - `startDate`
-  - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
+  - The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z')
 - `endDate`
-  - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
+  - The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z')
 
 ### Security
 
@@ -85,9 +89,9 @@ Platform API endpoints used:
 
 ## Voice Call Quality
 
-Retrieves voice call quality metrics for one or more conversations by ID. This tool specifically focuses
-on voice interactions and returns the minimum Mean Opinion Score (MOS) observed in each conversation, helping
-identify degraded or poor-quality voice calls.
+**Tool name:** `voice_call_quality`
+
+Retrieves voice call quality metrics for one or more conversations by ID. This tool specifically focuses on voice interactions and returns the minimum Mean Opinion Score (MOS) observed in each conversation, helping identify degraded or poor-quality voice calls.
 
 Read more [about MOS scores and how they're determined](https://developer.genesys.cloud/analyticsdatamanagement/analytics/detail/call-quality).
 
@@ -96,7 +100,7 @@ Read more [about MOS scores and how they're determined](https://developer.genesy
 ### Inputs
 
 - `conversationIds`
-  - A list of up to 100 conversation IDs to evaluate voice call quality for.
+  - A list of up to 100 conversation IDs to evaluate voice call quality for
 
 ### Security
 
@@ -110,16 +114,16 @@ Platform API endpoint used:
 
 ## Conversation Sentiment
 
-Retrieves sentiment analysis scores for one or more conversations. Sentiment is evaluated based on customer phrases,
-categorized as positive, neutral, or negative. The result includes both a numeric sentiment score (-100 to 100)
-and an interpreted sentiment label.
+**Tool name:** `conversation_sentiment`
+
+Retrieves sentiment analysis scores for one or more conversations. Sentiment is evaluated based on customer phrases, categorized as positive, neutral, or negative. The result includes both a numeric sentiment score (-100 to 100) and an interpreted sentiment label.
 
 [Source file](/src/tools/conversationSentiment.ts).
 
 ### Inputs
 
 - `conversationIds`
-  - A list of up to 100 conversation IDs to retrieve sentiment for.
+  - A list of up to 100 conversation IDs to retrieve sentiment for
 
 ### Security
 
@@ -134,9 +138,9 @@ Platform API endpoint used:
 
 ## Conversation Topics
 
-Retrieves Speech and Text Analytics topics detected for a specific conversation. Topics
-represent business-level intents (e.g. cancellation, billing enquiry) inferred from recognised
-phrases in the customer-agent interaction.
+**Tool name:** `conversation_topics`
+
+Retrieves Speech and Text Analytics topics detected for a specific conversation. Topics represent business-level intents (e.g. cancellation, billing enquiry) inferred from recognised phrases in the customer-agent interaction.
 
 Read more [about programs, topics, and phrases](https://help.mypurecloud.com/articles/about-programs-topics-and-phrases/).
 

src/tools/sampleConversationsByQueue.test.ts

@@ -63,12 +63,12 @@ describe("Query Queue Volumes Tool", () => {
           startDate: {
             type: "string",
             description:
-              "The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').",
+              "The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z')",
           },
           endDate: {
             type: "string",
             description:
-              "The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').",
+              "The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z')",
           },
         },
         required: ["queueId", "startDate", "endDate"],

src/tools/sampleConversationsByQueue.ts

@@ -25,12 +25,12 @@ const paramsSchema = z.object({
   startDate: z
     .string()
     .describe(
-      "The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').",
+      "The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z')",
     ),
   endDate: z
     .string()
     .describe(
-      "The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').",
+      "The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z')",
     ),
 });