Skip to content

Commit 30fc5cc

Browse files
SketchingDevSketchingDev
authored
Document tools (#9)
1 parent 90bfda2 commit 30fc5cc

File tree

3 files changed

+87
-9
lines changed

3 files changed

+87
-9
lines changed

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55

66
A Model Context Protocol (MCP) server for Genesys Cloud's Platform API.
77

8-
## Tools
8+
## Tools Overview
99

10-
Below are the tools this MPC server makes available. Alongside each tool are the Genesys Cloud endpoints
11-
used and the permissions your OAuth Client needs to use them.
10+
An overview of the tools that this MPC server makes available. Read more about each specific tool
11+
in the [tools doc](/docs/tools.md).
1212

13-
| Tool | Permissions | APIs used |
14-
| ----------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15-
| Search Queues | `routing:queue:view` | [`GET /api/v2/routing/queues`](https://developer.genesys.cloud/routing/routing/#get-api-v2-routing-queues) |
16-
| Query Queue Volumes | `analytics:conversationDetail:view` | [`POST /api/v2/analytics/conversations/details/jobs`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs)<br/>[`GET /api/v2/analytics/conversations/details/jobs/{jobId}`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId-)<br/>[`GET /api/v2/analytics/conversations/details/jobs/{jobId}/results`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results) |
17-
| Sample Conversations By Queue | `analytics:conversationDetail:view` | [`POST /api/v2/analytics/conversations/details/jobs`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs)<br/>[`GET /api/v2/analytics/conversations/details/jobs/{jobId}`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId-)<br/>[`GET /api/v2/analytics/conversations/details/jobs/{jobId}/results`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results) |
13+
| Tool | Description |
14+
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------- |
15+
| [Search Queues](/docs/tools.md#search-queues) | Searches for queues by their name (supports wildcards) |
16+
| [Query Queue Volumes](/docs/tools.md#query-queue-volumes) | Determines conversation volumes and member count by Queue IDs |
17+
| [Sample Conversations By Queue](/docs/tools.md#sample-conversations-by-queue) | Extracts a representative sample of Conversation IDs for a Queue ID |
1818

1919
## Authentication
2020

‎docs/tools.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Tools
2+
3+
## Search Queues
4+
5+
Searches for routing queues based on their name, allowing for wildcard searches. Returns a paginated
6+
list of matching queues, including their Name, ID, Description (if available), and Member Count
7+
(if available). Also provides pagination details like current page, page size, total results found,
8+
and total pages available. Useful for finding specific queue IDs, checking queue configurations,
9+
or listing available queues.
10+
11+
[Source file](/src/tools/searchQueues.ts).
12+
13+
### Inputs
14+
15+
* `name`
16+
* 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.
17+
* `pageNumber`
18+
* 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.
19+
* `pageSize`
20+
* 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.
21+
22+
### Security
23+
24+
Required permission:
25+
* `routing:queue:view`
26+
27+
Platform API endpoints used:
28+
* [`GET /api/v2/routing/queues`](https://developer.genesys.cloud/routing/routing/#get-api-v2-routing-queues)
29+
30+
## Query Queue Volumes
31+
32+
Returns a breakdown of how many conversations occurred in each specified queue between two
33+
dates. Useful for comparing workload across queues.
34+
35+
[Source file](/src/tools/queryQueueVolumes.ts).
36+
37+
### Inputs
38+
39+
* `queueIds`
40+
* The IDs of the queues to filter conversations by. Max 300.
41+
* `startDate`
42+
* The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
43+
* `endDate`
44+
* The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
45+
46+
### Security
47+
48+
Required permission:
49+
* `analytics:conversationDetail:view`
50+
51+
Platform API endpoints used:
52+
* [`POST /api/v2/analytics/conversations/details/jobs`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs)
53+
* [`GET /api/v2/analytics/conversations/details/jobs/{jobId}`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId-)
54+
* [`GET /api/v2/analytics/conversations/details/jobs/{jobId}/results`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results)
55+
56+
## Sample Conversations By Queue
57+
58+
Retrieves conversation analytics for a specific queue between two dates, returning a
59+
representative sample of conversation IDs. Useful for reporting, investigation, or summarisation.
60+
61+
### Inputs
62+
63+
* `queueId`
64+
* The ID of the queue to filter conversations by.
65+
* `startDate`
66+
* The start date/time in ISO-8601 format (e.g., '2024-01-01T00:00:00Z').
67+
* `endDate`
68+
* The end date/time in ISO-8601 format (e.g., '2024-01-07T23:59:59Z').
69+
70+
### Security
71+
72+
Required Permissions:
73+
* `analytics:conversationDetail:view`
74+
75+
Platform API endpoints used:
76+
* [`POST /api/v2/analytics/conversations/details/jobs`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#post-api-v2-analytics-conversations-details-jobs)
77+
* [`GET /api/v2/analytics/conversations/details/jobs/{jobId}`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId-)
78+
* [`GET /api/v2/analytics/conversations/details/jobs/{jobId}/results`](https://developer.genesys.cloud/analyticsdatamanagement/analytics/analytics-apis#get-api-v2-analytics-conversations-details-jobs--jobId--results)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@makingchatbots/genesys-cloud-mcp-server",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"description": "A MCP server for connecting LLMs to Genesys Cloud's Platform API",
55
"exports": "./dist/index.js",
66
"type": "module",

0 commit comments

Comments
 (0)