fix(x): correct API spec issues in retweeted_by, quote_tweets, personalized_trends, and usage tools

Author: waleedlatif1

apps/sim/tools/x/get_personalized_trends.ts

@@ -1,13 +1,13 @@
 import { createLogger } from '@sim/logger'
 import type { ToolConfig } from '@/tools/types'
-import type { XGetPersonalizedTrendsParams, XTrendListResponse } from '@/tools/x/types'
-import { transformTrend } from '@/tools/x/types'
+import type { XGetPersonalizedTrendsParams, XPersonalizedTrendListResponse } from '@/tools/x/types'
+import { transformPersonalizedTrend } from '@/tools/x/types'
 
 const logger = createLogger('XGetPersonalizedTrendsTool')
 
 export const xGetPersonalizedTrendsTool: ToolConfig<
   XGetPersonalizedTrendsParams,
-  XTrendListResponse
+  XPersonalizedTrendListResponse
 > = {
   id: 'x_get_personalized_trends',
   name: 'X Get Personalized Trends',
@@ -29,7 +29,7 @@ export const xGetPersonalizedTrendsTool: ToolConfig<
   },
 
   request: {
-    url: 'https://api.x.com/2/users/personalized_trends',
+    url: 'https://api.x.com/2/users/personalized_trends?personalized_trend.fields=category,post_count,trend_name,trending_since',
     method: 'GET',
     headers: (params) => ({
       Authorization: `Bearer ${params.accessToken}`,
@@ -54,7 +54,7 @@ export const xGetPersonalizedTrendsTool: ToolConfig<
     return {
       success: true,
       output: {
-        trends: data.data.map(transformTrend),
+        trends: data.data.map(transformPersonalizedTrend),
       },
     }
   },
@@ -67,9 +67,19 @@ export const xGetPersonalizedTrendsTool: ToolConfig<
         type: 'object',
         properties: {
           trendName: { type: 'string', description: 'Name of the trending topic' },
-          tweetCount: {
+          postCount: {
             type: 'number',
-            description: 'Number of tweets for this trend',
+            description: 'Number of posts for this trend',
+            optional: true,
+          },
+          category: {
+            type: 'string',
+            description: 'Category of the trend',
+            optional: true,
+          },
+          trendingSince: {
+            type: 'string',
+            description: 'ISO 8601 timestamp of when the topic started trending',
             optional: true,
           },
         },

apps/sim/tools/x/get_quote_tweets.ts

@@ -41,12 +41,6 @@ export const xGetQuoteTweetsTool: ToolConfig<XGetQuoteTweetsParams, XTweetListRe
       visibility: 'user-or-llm',
       description: 'Pagination token for next page',
     },
-    exclude: {
-      type: 'string',
-      required: false,
-      visibility: 'user-or-llm',
-      description: 'Comma-separated types to exclude: "retweets", "replies"',
-    },
   },
 
   request: {
@@ -62,7 +56,6 @@ export const xGetQuoteTweetsTool: ToolConfig<XGetQuoteTweetsParams, XTweetListRe
         queryParams.append('max_results', max.toString())
       }
       if (params.paginationToken) queryParams.append('pagination_token', params.paginationToken)
-      if (params.exclude) queryParams.append('exclude', params.exclude)
 
       return `https://api.x.com/2/tweets/${params.tweetId.trim()}/quote_tweets?${queryParams.toString()}`
     },

apps/sim/tools/x/get_retweeted_by.ts

@@ -50,7 +50,8 @@ export const xGetRetweetedByTool: ToolConfig<XGetRetweetedByParams, XUserListRes
       })
 
       if (params.maxResults) {
-        queryParams.append('max_results', Number(params.maxResults).toString())
+        const max = Math.max(1, Math.min(100, Number(params.maxResults)))
+        queryParams.append('max_results', max.toString())
       }
       if (params.paginationToken) queryParams.append('pagination_token', params.paginationToken)
 

apps/sim/tools/x/get_usage.ts

@@ -33,7 +33,8 @@ export const xGetUsageTool: ToolConfig<XGetUsageParams, XGetUsageResponse> = {
   request: {
     url: (params) => {
       const queryParams = new URLSearchParams({
-        'usage.fields': 'cap_reset_day,daily_project_usage,project_cap,project_id,project_usage',
+        'usage.fields':
+          'cap_reset_day,daily_client_app_usage,daily_project_usage,project_cap,project_id,project_usage',
       })
 
       if (params.days) {
@@ -63,6 +64,7 @@ export const xGetUsageTool: ToolConfig<XGetUsageParams, XGetUsageResponse> = {
           projectCap: null,
           projectUsage: null,
           dailyProjectUsage: [],
+          dailyClientAppUsage: [],
         },
       }
     }
@@ -80,6 +82,15 @@ export const xGetUsageTool: ToolConfig<XGetUsageParams, XGetUsageResponse> = {
             usage: u.usage ?? 0,
           })
         ),
+        dailyClientAppUsage: (data.data.daily_client_app_usage ?? []).map(
+          (app: { client_app_id: string; usage: { date: string; usage: number }[] }) => ({
+            clientAppId: String(app.client_app_id ?? ''),
+            usage: (app.usage ?? []).map((u: { date: string; usage: number }) => ({
+              date: u.date,
+              usage: u.usage ?? 0,
+            })),
+          })
+        ),
       },
     }
   },
@@ -106,7 +117,7 @@ export const xGetUsageTool: ToolConfig<XGetUsageParams, XGetUsageResponse> = {
     },
     dailyProjectUsage: {
       type: 'array',
-      description: 'Daily usage breakdown',
+      description: 'Daily project usage breakdown',
       items: {
         type: 'object',
         properties: {
@@ -115,5 +126,26 @@ export const xGetUsageTool: ToolConfig<XGetUsageParams, XGetUsageResponse> = {
         },
       },
     },
+    dailyClientAppUsage: {
+      type: 'array',
+      description: 'Daily per-app usage breakdown',
+      items: {
+        type: 'object',
+        properties: {
+          clientAppId: { type: 'string', description: 'Client application ID' },
+          usage: {
+            type: 'array',
+            description: 'Daily usage entries for this app',
+            items: {
+              type: 'object',
+              properties: {
+                date: { type: 'string', description: 'Usage date in ISO 8601 format' },
+                usage: { type: 'number', description: 'Number of tweets consumed' },
+              },
+            },
+          },
+        },
+      },
+    },
   },
 }

apps/sim/tools/x/types.ts

@@ -186,21 +186,41 @@ export const transformUser = (user: any): XUser => ({
 })
 
 /**
- * Trend object from X API
+ * Trend object from X API (WOEID trends)
  */
 export interface XTrend {
   trendName: string
   tweetCount: number | null
 }
 
 /**
- * Transforms raw X API trend data into the XTrend format
+ * Personalized trend object from X API
+ */
+export interface XPersonalizedTrend {
+  trendName: string
+  postCount: number | null
+  category: string | null
+  trendingSince: string | null
+}
+
+/**
+ * Transforms raw X API trend data (WOEID) into the XTrend format
  */
 export const transformTrend = (trend: any): XTrend => ({
   trendName: trend.trend_name ?? trend.name ?? '',
   tweetCount: trend.tweet_count ?? null,
 })
 
+/**
+ * Transforms raw X API personalized trend data into the XPersonalizedTrend format
+ */
+export const transformPersonalizedTrend = (trend: any): XPersonalizedTrend => ({
+  trendName: trend.trend_name ?? '',
+  postCount: trend.post_count ?? null,
+  category: trend.category ?? null,
+  trendingSince: trend.trending_since ?? null,
+})
+
 // --- New Tool Parameter Interfaces ---
 
 export interface XSearchTweetsParams extends XBaseParams {
@@ -432,6 +452,10 @@ export interface XGetUsageResponse extends ToolResponse {
     projectCap: number | null
     projectUsage: number | null
     dailyProjectUsage: Array<{ date: string; usage: number }>
+    dailyClientAppUsage: Array<{
+      clientAppId: string
+      usage: Array<{ date: string; usage: number }>
+    }>
   }
 }
 
@@ -487,3 +511,9 @@ export interface XTrendListResponse extends ToolResponse {
     trends: XTrend[]
   }
 }
+
+export interface XPersonalizedTrendListResponse extends ToolResponse {
+  output: {
+    trends: XPersonalizedTrend[]
+  }
+}