Add docs

Author: SketchingDev

README.md

@@ -8,7 +8,7 @@ A Model Context Protocol (MCP) server for Genesys Cloud's Platform API.
 ## Features
 
 | Tool                                                                          | Description                                                              |
-| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
+|-------------------------------------------------------------------------------|--------------------------------------------------------------------------|
 | [Search Queues](/docs/tools.md#search-queues)                                 | Searches for queues by their name (supports wildcards)                   |
 | [Query Queue Volumes](/docs/tools.md#query-queue-volumes)                     | Retrieves conversation volumes and member count by Queue IDs             |
 | [Sample Conversations By Queue](/docs/tools.md#sample-conversations-by-queue) | Retrieves a representative sample of Conversation IDs for a Queue ID     |
@@ -17,6 +17,8 @@ A Model Context Protocol (MCP) server for Genesys Cloud's Platform API.
 | [Conversation Topics](/docs/tools.md#conversation-topics)                     | Retrieves the topics for a conversation by ID                            |
 | [Search Voice Conversation](/docs/tools.md#search-voice-conversations)        | Searches voice conversations by optional criteria                        |
 | [Conversation Transcript](/docs/tools.md#conversation-transcript)             | Retrieves conversation transcript                                        |
+| [OAuth Clients](/docs/tools.md#oauth-clients)                                 | Retrieves a list of all the OAuth clients                                |
+| [OAuth Client Usage](/docs/tools.md#oauth-client-usage)                       | Retrieves usage of an OAuth client                                       |
 
 ## Usage with Claude Desktop
 

docs/tools.md

@@ -215,3 +215,53 @@ Platform API endpoints used:
 
 - [GET /api/v2/conversations/{conversationId}/recordings](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-conversations--conversationId--recordings)
 - [GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-speechandtextanalytics-conversations--conversationId--communications--communicationId--transcripturl)
+
+## OAuth Clients
+
+**Tool name:** `oauth_clients`
+
+Retrieves a list of all OAuth clients, including their associated roles and divisions. This tool is useful for auditing and managing OAuth clients in the Genesys Cloud organization.
+
+[Source file](/src/tools/oauthClients/oauthClients.ts).
+
+### Security
+
+Required Permissions:
+
+- `oauth:client:view`
+- `authorization:role:view`
+  - Optional: Used to populate names of roles used by OAuth Client
+
+Platform API endpoints used:
+
+- [GET /api/v2/oauth/clients](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-oauth-clients)
+- [GET /api/v2/authorization/divisions](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-authorization-divisions)
+- [GET /api/v2/authorization/roles](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-authorization-roles)
+
+## OAuth Client Usage
+
+**Tool name:** `oauth_client_usage`
+
+Retrieves the usage of an OAuth Client for a given period. It returns the total number of requests and a breakdown of requests per organization
+
+[Source file](/src/tools/oauthClientUsage/oauthClientUsage.ts).
+
+### Input
+
+- `oauthClientId`
+    - The UUID of the OAuth Client to retrieve the usage for (e.g., 00000000-0000-0000-0000-000000000000)
+- `startDate`
+    - 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')
+
+### Security
+
+Required Permissions:
+
+- `usage:client:view`
+
+Platform API endpoints used:
+
+- [POST /api/v2/oauth/clients/{clientId}/usage/query](https://developer.genesys.cloud/devapps/api-explorer-standalone#post-api-v2-oauth-clients--clientId--usage-query)
+- [GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}](https://developer.genesys.cloud/devapps/api-explorer-standalone#get-api-v2-oauth-clients--clientId--usage-query-results--executionId-)