@novu/api 1.0.0 → 1.1.0

package/src/funcs/integrationsCreate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create integration
+ * Create an integration
  *
  * @remarks
- * Create an integration for the current environment the user is based on the API key provided
+ * Create an integration for the current environment the user is based on the API key provided.
+ *     Each provider supports different credentials, check the provider documentation for more details.
  */
 export function integrationsCreate(
   client: NovuCore,

package/src/funcs/integrationsDelete.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete integration
+ * Delete an integration
+ *
+ * @remarks
+ * Delete an integration by its unique key identifier **integrationId**.
+ *     This action is irreversible.
  */
 export function integrationsDelete(
   client: NovuCore,

package/src/funcs/integrationsList.ts

@@ -25,10 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get integrations
+ * List all integrations
  *
  * @remarks
- * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+ * List all the channels integrations created in the organization
  */
 export function integrationsList(
   client: NovuCore,

package/src/funcs/integrationsListActive.ts

@@ -25,10 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get active integrations
+ * List active integrations
  *
  * @remarks
- * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+ * List all the active integrations created in the organization
  */
 export function integrationsListActive(
   client: NovuCore,

package/src/funcs/integrationsSetAsPrimary.ts

@@ -25,7 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Set integration as primary
+ * Update integration as primary
+ *
+ * @remarks
+ * Update an integration as **primary** by its unique key identifier **integrationId**.
+ *     This API will set the integration as primary for that channel in the current environment.
+ *     Primary integration is used to deliver notification for sms and email channels in the workflow.
  */
 export function integrationsSetAsPrimary(
   client: NovuCore,

package/src/funcs/integrationsUpdate.ts

@@ -26,7 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update integration
+ * Update an integration
+ *
+ * @remarks
+ * Update an integration by its unique key identifier **integrationId**.
+ *     Each provider supports different credentials, check the provider documentation for more details.
  */
 export function integrationsUpdate(
   client: NovuCore,

package/src/funcs/messagesDelete.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete message
+ * Delete a message
  *
  * @remarks
- * Deletes a message entity from the Novu platform
+ * Delete a message entity from the Novu platform by **messageId**.
+ *     This action is irreversible. **messageId** is required and of mongodbId type.
  */
 export function messagesDelete(
   client: NovuCore,

package/src/funcs/messagesDeleteByTransactionId.ts

@@ -28,7 +28,8 @@ import { Result } from "../types/fp.js";
  * Delete messages by transactionId
  *
  * @remarks
- * Deletes messages entity from the Novu platform using TransactionId of message
+ * Delete multiple messages from the Novu platform using **transactionId** of triggered event.
+ *     This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
  */
 export function messagesDeleteByTransactionId(
   client: NovuCore,

package/src/funcs/messagesRetrieve.ts

@@ -25,10 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get messages
+ * List all messages
  *
  * @remarks
- * Returns a list of messages, could paginate using the `page` query parameter
+ * List all messages for the current environment.
+ *     This API supports filtering by **channel**, **subscriberId**, and **transactionId**.
+ *     This API returns a paginated list of messages.
  */
 export function messagesRetrieve(
   client: NovuCore,

package/src/funcs/notificationsList.ts

@@ -25,7 +25,13 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get notifications
+ * List all events
+ *
+ * @remarks
+ * List all notification events (triggered events) for the current environment.
+ *     This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**.
+ *     Checkout all available filters in the query section.
+ *     This API returns event triggers, to list each channel notifications, check messages APIs.
  */
 export function notificationsList(
   client: NovuCore,

package/src/funcs/notificationsRetrieve.ts

@@ -25,7 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get notification
+ * Retrieve an event
+ *
+ * @remarks
+ * Retrieve an event by its unique key identifier **notificationId**.
+ *     Here **notificationId** is of mongodbId type.
+ *     This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
  */
 export function notificationsRetrieve(
   client: NovuCore,

package/src/funcs/subscribersCreate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create subscriber
+ * Create a subscriber
  *
  * @remarks
- * Create subscriber with the given data, if the subscriber already exists, it will be updated
+ * Create a subscriber with the subscriber attributes.
+ *       **subscriberId** is a required field, rest other fields are optional, if the subscriber already exists, it will be updated
  */
 export function subscribersCreate(
   client: NovuCore,

package/src/funcs/subscribersCreateBulk.ts

@@ -30,8 +30,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- *       Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
- *       The bulk API is limited to 500 subscribers per request.
+ *       Using this endpoint multiple subscribers can be created at once. The bulk API is limited to 500 subscribers per request.
  */
 export function subscribersCreateBulk(
   client: NovuCore,

package/src/funcs/subscribersCredentialsAppend.ts

@@ -26,11 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Modify subscriber credentials
+ * Upsert provider credentials
  *
  * @remarks
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
- *     This endpoint appends provided credentials and deviceTokens to the existing ones.
+ * Update credentials for a provider such as **slack** and **FCM**.
+ *       **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
  */
 export function subscribersCredentialsAppend(
   client: NovuCore,

package/src/funcs/subscribersCredentialsDelete.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete subscriber credentials by providerId
+ * Delete provider credentials
  *
  * @remarks
- * Delete subscriber credentials such as slack and expo tokens.
+ * Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**.
+ *     This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.
  */
 export function subscribersCredentialsDelete(
   client: NovuCore,

package/src/funcs/subscribersCredentialsUpdate.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update subscriber credentials
+ * Update provider credentials
  *
  * @remarks
- * Subscriber credentials associated to the delivery methods such as slack and push tokens.
+ * Update credentials for a provider such as slack and push tokens.
+ *       **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
  */
 export function subscribersCredentialsUpdate(
   client: NovuCore,

package/src/funcs/subscribersDelete.ts

@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
  * Delete subscriber
  *
  * @remarks
- * Deletes a subscriber entity from the Novu platform
+ * Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions
  */
 export function subscribersDelete(
   client: NovuCore,

package/src/funcs/subscribersMessagesMarkAll.ts

@@ -26,7 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Marks all the subscriber messages as read, unread, seen or unseen.
+ * Update all notifications state
+ *
+ * @remarks
+ * Update all subscriber in-app (inbox) notifications state such as read, unread, seen or unseen by **subscriberId**.
  */
 export function subscribersMessagesMarkAll(
   client: NovuCore,

package/src/funcs/subscribersMessagesMarkAllAs.ts

@@ -26,7 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Mark a subscriber messages as seen, read, unseen or unread
+ * Update notifications state
+ *
+ * @remarks
+ * Update subscriber's multiple in-app (inbox) notifications state such as seen, read, unseen or unread by **subscriberId**.
+ *       **messageId** is of type mongodbId of notifications
  */
 export function subscribersMessagesMarkAllAs(
   client: NovuCore,

package/src/funcs/subscribersMessagesUpdateAsSeen.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Mark message action as seen
+ * Update notification action status
+ *
+ * @remarks
+ * Update in-app (inbox) notification's action status by its unique key identifier **messageId** and type field **type**.
+ *       **type** field can be **primary** or **secondary**
  */
 export function subscribersMessagesUpdateAsSeen(
   client: NovuCore,

package/src/funcs/subscribersNotificationsFeed.ts

@@ -25,7 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get in-app notification feed for a particular subscriber
+ * Retrieve subscriber notifications
+ *
+ * @remarks
+ * Retrieve subscriber in-app (inbox) notifications by its unique key identifier **subscriberId**.
  */
 export function subscribersNotificationsFeed(
   client: NovuCore,

package/src/funcs/subscribersNotificationsUnseenCount.ts

@@ -25,7 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get the unseen in-app notifications count for subscribers feed
+ * Retrieve unseen notifications count
+ *
+ * @remarks
+ * Retrieve unseen in-app (inbox) notifications count for a subscriber by its unique key identifier **subscriberId**.
  */
 export function subscribersNotificationsUnseenCount(
   client: NovuCore,

package/src/funcs/subscribersPatch.ts

@@ -26,10 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Patch subscriber
+ * Update a subscriber
  *
  * @remarks
- * Patch subscriber by your internal id used to identify the subscriber
+ * Update a subscriber by its unique key identifier **subscriberId**.
+ *     **subscriberId** is a required field, rest other fields are optional
  */
 export function subscribersPatch(
   client: NovuCore,

package/src/funcs/subscribersPreferencesList.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get subscriber preferences
+ * Retrieve subscriber preferences
  *
  * @remarks
- * Get subscriber global and workflow specific preferences
+ * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
+ *     This API returns all five channels preferences for all workflows and global preferences.
  */
 export function subscribersPreferencesList(
   client: NovuCore,

package/src/funcs/subscribersPreferencesUpdate.ts

@@ -26,10 +26,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update subscriber global or workflow specific preferences
+ * Update subscriber preferences
  *
  * @remarks
- * Update subscriber global or workflow specific preferences
+ * Update subscriber preferences by its unique key identifier **subscriberId**.
+ *     **workflowId** is optional field, if provided, this API will update that workflow preference,
+ *     otherwise it will update global preferences
  */
 export function subscribersPreferencesUpdate(
   client: NovuCore,

package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Update subscriber online status
  *
  * @remarks
- * Used to update the subscriber isOnline flag.
+ * Update the subscriber online status by its unique key identifier **subscriberId**
  */
 export function subscribersPropertiesUpdateOnlineFlag(
   client: NovuCore,

package/src/funcs/subscribersRetrieve.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get subscriber
+ * Retrieve a subscriber
  *
  * @remarks
- * Get subscriber by your internal id used to identify the subscriber
+ * Retrive a subscriber by its unique key identifier **subscriberId**.
+ *     **subscriberId** field is required.
  */
 export function subscribersRetrieve(
   client: NovuCore,

package/src/funcs/subscribersSearch.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Search for subscribers
+ * Search subscribers
+ *
+ * @remarks
+ * Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
+ *     The search is case sensitive and supports pagination.Checkout all available filters in the query section.
  */
 export function subscribersSearch(
   client: NovuCore,

package/src/funcs/subscribersTopicsList.ts

@@ -25,10 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List topics a subscriber is subscribed to
+ * Retrieve subscriber subscriptions
  *
  * @remarks
- * List topic subscriptions for a subscriber with pagination and filtering
+ * Retrieve subscriber's topic subscriptions by its unique key identifier **subscriberId**.
+ *     Checkout all available filters in the query section.
  */
 export function subscribersTopicsList(
   client: NovuCore,

package/src/funcs/topicsCreate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create or update a topic
+ * Create a topic
  *
  * @remarks
  * Creates a new topic if it does not exist, or updates an existing topic if it already exists

package/src/funcs/topicsDelete.ts

@@ -25,7 +25,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete topic by key
+ * Delete a topic
+ *
+ * @remarks
+ * Delete a topic by its unique key identifier **topicKey**.
+ *     This action is irreversible and will remove all subscriptions to the topic.
  */
 export function topicsDelete(
   client: NovuCore,

package/src/funcs/topicsGet.ts

@@ -25,7 +25,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get topic by key
+ * Retrieve a topic
+ *
+ * @remarks
+ * Retrieve a topic by its unique key identifier **topicKey**
  */
 export function topicsGet(
   client: NovuCore,

package/src/funcs/topicsList.ts

@@ -25,7 +25,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get topics list
+ * List all topics
+ *
+ * @remarks
+ * This api returns a paginated list of topics.
+ *     Topics can be filtered by **key**, **name**, or **includeCursor** to paginate through the list.
+ *     Checkout all available filters in the query section.
  */
 export function topicsList(
   client: NovuCore,

package/src/funcs/topicsSubscriptionsCreate.ts

@@ -26,7 +26,11 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create topic subscriptions, if the topic does not exist, it will be created.
+ * Create topic subscriptions
+ *
+ * @remarks
+ * This api will create subscription for subscriberIds for a topic.
+ *       Its like subscribing to a common interest group. if topic does not exist, it will be created.
  */
 export function topicsSubscriptionsCreate(
   client: NovuCore,

package/src/funcs/topicsSubscriptionsDelete.ts

@@ -27,6 +27,9 @@ import { Result } from "../types/fp.js";
 
 /**
  * Delete topic subscriptions
+ *
+ * @remarks
+ * Delete subscriptions for subscriberIds for a topic.
  */
 export function topicsSubscriptionsDelete(
   client: NovuCore,

package/src/funcs/topicsSubscriptionsList.ts

@@ -26,6 +26,10 @@ import { Result } from "../types/fp.js";
 
 /**
  * List topic subscriptions
+ *
+ * @remarks
+ * List all topics that a subscriber is subscribed to.
+ *     Checkout all available filters in the query section.
  */
 export function topicsSubscriptionsList(
   client: NovuCore,

package/src/funcs/topicsUpdate.ts

@@ -26,7 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update topic by key
+ * Update a topic
+ *
+ * @remarks
+ * Update a topic name by its unique key identifier **topicKey**
  */
 export function topicsUpdate(
   client: NovuCore,

package/src/lib/config.ts

@@ -54,8 +54,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "2.1.13",
-  sdkVersion: "1.0.0",
-  genVersion: "2.599.0",
-  userAgent: "speakeasy-sdk/typescript 1.0.0 2.599.0 2.1.13 @novu/api",
+  openapiDocVersion: "2.2.0",
+  sdkVersion: "1.1.0",
+  genVersion: "2.605.6",
+  userAgent: "speakeasy-sdk/typescript 1.1.0 2.605.6 2.2.0 @novu/api",
 } as const;

package/src/mcp-server/cli/start/impl.ts

@@ -50,7 +50,7 @@ async function startStdio(flags: StartCommandFlags) {
     logger,
     allowedTools: flags.tool,
     scopes: flags.scope,
-    ...{ secretKey: flags["secret-key"] },
+    ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
   });
@@ -71,7 +71,7 @@ async function startSSE(flags: StartCommandFlags) {
     logger,
     allowedTools: flags.tool,
     scopes: flags.scope,
-    ...{ secretKey: flags["secret-key"] },
+    ...{ secretKey: flags["secret-key"] ?? "" },
     serverURL: flags["server-url"],
     serverIdx: flags["server-index"],
   });

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.0.0",
+    currentVersion: "1.1.0",
   },
 });
 

package/src/mcp-server/server.ts

@@ -20,23 +20,17 @@ import { tool$integrationsList } from "./tools/integrationsList.js";
 import { tool$integrationsListActive } from "./tools/integrationsListActive.js";
 import { tool$integrationsSetAsPrimary } from "./tools/integrationsSetAsPrimary.js";
 import { tool$integrationsUpdate } from "./tools/integrationsUpdate.js";
-import { tool$integrationsWebhooksRetrieve } from "./tools/integrationsWebhooksRetrieve.js";
 import { tool$messagesDelete } from "./tools/messagesDelete.js";
 import { tool$messagesDeleteByTransactionId } from "./tools/messagesDeleteByTransactionId.js";
 import { tool$messagesRetrieve } from "./tools/messagesRetrieve.js";
 import { tool$notificationsList } from "./tools/notificationsList.js";
 import { tool$notificationsRetrieve } from "./tools/notificationsRetrieve.js";
-import { tool$notificationsStatsGraph } from "./tools/notificationsStatsGraph.js";
-import { tool$notificationsStatsRetrieve } from "./tools/notificationsStatsRetrieve.js";
-import { tool$subscribersAuthenticationChatAccessOauth } from "./tools/subscribersAuthenticationChatAccessOauth.js";
-import { tool$subscribersAuthenticationChatAccessOauthCallBack } from "./tools/subscribersAuthenticationChatAccessOauthCallBack.js";
 import { tool$subscribersCreate } from "./tools/subscribersCreate.js";
 import { tool$subscribersCreateBulk } from "./tools/subscribersCreateBulk.js";
 import { tool$subscribersCredentialsAppend } from "./tools/subscribersCredentialsAppend.js";
 import { tool$subscribersCredentialsDelete } from "./tools/subscribersCredentialsDelete.js";
 import { tool$subscribersCredentialsUpdate } from "./tools/subscribersCredentialsUpdate.js";
 import { tool$subscribersDelete } from "./tools/subscribersDelete.js";
-import { tool$subscribersList } from "./tools/subscribersList.js";
 import { tool$subscribersMessagesMarkAll } from "./tools/subscribersMessagesMarkAll.js";
 import { tool$subscribersMessagesMarkAllAs } from "./tools/subscribersMessagesMarkAllAs.js";
 import { tool$subscribersMessagesUpdateAsSeen } from "./tools/subscribersMessagesUpdateAsSeen.js";
@@ -49,7 +43,6 @@ import { tool$subscribersPropertiesUpdateOnlineFlag } from "./tools/subscribersP
 import { tool$subscribersRetrieve } from "./tools/subscribersRetrieve.js";
 import { tool$subscribersSearch } from "./tools/subscribersSearch.js";
 import { tool$subscribersTopicsList } from "./tools/subscribersTopicsList.js";
-import { tool$subscribersUpsert } from "./tools/subscribersUpsert.js";
 import { tool$topicsCreate } from "./tools/topicsCreate.js";
 import { tool$topicsDelete } from "./tools/topicsDelete.js";
 import { tool$topicsGet } from "./tools/topicsGet.js";
@@ -73,7 +66,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.0.0",
+    version: "1.1.0",
   });
 
   const client = new NovuCore({
@@ -112,8 +105,6 @@ export function createMCPServer(deps: {
   tool(tool$subscribersRetrieve);
   tool(tool$subscribersPatch);
   tool(tool$subscribersDelete);
-  tool(tool$subscribersList);
-  tool(tool$subscribersUpsert);
   tool(tool$subscribersCreateBulk);
   tool(tool$topicsList);
   tool(tool$topicsCreate);
@@ -137,8 +128,6 @@ export function createMCPServer(deps: {
   tool(tool$subscribersCredentialsUpdate);
   tool(tool$subscribersCredentialsAppend);
   tool(tool$subscribersCredentialsDelete);
-  tool(tool$subscribersAuthenticationChatAccessOauth);
-  tool(tool$subscribersAuthenticationChatAccessOauthCallBack);
   tool(tool$subscribersMessagesUpdateAsSeen);
   tool(tool$subscribersMessagesMarkAll);
   tool(tool$subscribersMessagesMarkAllAs);
@@ -149,9 +138,6 @@ export function createMCPServer(deps: {
   tool(tool$topicsSubscriptionsCreate);
   tool(tool$topicsSubscriptionsDelete);
   tool(tool$topicsSubscribersRetrieve);
-  tool(tool$integrationsWebhooksRetrieve);
-  tool(tool$notificationsStatsGraph);
-  tool(tool$notificationsStatsRetrieve);
 
   return server;
 }

package/src/mcp-server/tools/integrationsCreate.ts

@@ -15,9 +15,10 @@ const args = {
 
 export const tool$integrationsCreate: ToolDefinition<typeof args> = {
   name: "integrations-create",
-  description: `Create integration
+  description: `Create an integration
 
-Create an integration for the current environment the user is based on the API key provided`,
+Create an integration for the current environment the user is based on the API key provided. 
+    Each provider supports different credentials, check the provider documentation for more details.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await integrationsCreate(