Skip to content

Commit a146d7f

Browse files
committed
add icon for sends in tools list
1 parent ec82a2a commit a146d7f

File tree

2 files changed

+34
-21
lines changed

2 files changed

+34
-21
lines changed

TOOLS.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
# Available Iterable MCP Tools (104 tools)
22

3-
**Legend:** 🔒 = Contains PII, ✏️ = Write operation
3+
**Legend:**
4+
- 🔒 = Requires enabling user PII access
5+
- ✏️ = Requires enabling writes
6+
- ✉️ = Requires enabling sends
7+
48

59
## Campaigns (13 tools)
610
- **abort_campaign** ✏️: Abort a campaign that is currently running
7-
- **activate_triggered_campaign** ✏️: Activate a triggered campaign (requires API triggered campaign activation enabled)
11+
- **activate_triggered_campaign** ✏️✉️: Activate a triggered campaign (requires API triggered campaign activation enabled)
812
- **archive_campaigns** ✏️: Archive one or more campaigns. Scheduled/recurring campaigns will be cancelled, running campaigns will be aborted.
913
- **cancel_campaign** ✏️: Cancel a scheduled or recurring campaign
10-
- **create_campaign** ✏️: Create a new blast or triggered campaign from an existing template. If listIds are provided, the campaign will be a blast campaign, otherwise it will be a triggered campaign. Blast campaigns will be sent immediately if sendAt is not provided.
14+
- **create_campaign** ✏️✉️: Create a new blast or triggered campaign from an existing template. If listIds are provided, the campaign will be a blast campaign, otherwise it will be a triggered campaign. Blast campaigns will be sent immediately if sendAt is not provided.
1115
- **deactivate_triggered_campaign** ✏️: Deactivate a triggered campaign (requires API triggered campaign deactivation enabled)
1216
- **get_campaign**: Get detailed information about a specific campaign
1317
- **get_campaign_metrics**: Get campaign performance metrics
1418
- **get_campaigns**: Retrieve campaigns
1519
- **get_child_campaigns**: Get child campaigns generated by a recurring campaign
16-
- **schedule_campaign** ✏️: Schedule an existing campaign to be sent at a specific time
17-
- **send_campaign** ✏️: Send an existing scheduled campaign immediately
18-
- **trigger_campaign** ✏️: Trigger a campaign to send to specified lists
20+
- **schedule_campaign** ✏️✉️: Schedule an existing campaign to be sent at a specific time
21+
- **send_campaign** ✏️✉️: Send an existing scheduled campaign immediately
22+
- **trigger_campaign** ✏️✉️: Trigger a campaign to send to specified lists
1923

2024
## Catalogs (12 tools)
2125
- **bulk_delete_catalog_items** ✏️: Bulk delete catalog items by their IDs
@@ -41,15 +45,15 @@
4145
## Events (4 tools)
4246
- **get_user_events_by_email** 🔒: Get event history for a user by email address
4347
- **get_user_events_by_user_id** 🔒: Get event history for a user by user ID
44-
- **track_bulk_events** 🔒✏️: Track multiple events in a single request for better performance
45-
- **track_event** 🔒✏️: Track a custom event for a user
48+
- **track_bulk_events** 🔒✏️✉️: Track multiple events in a single request for better performance
49+
- **track_event** 🔒✏️✉️: Track a custom event for a user
4650

4751
## Experiments (1 tools)
4852
- **get_experiment_metrics**: Get experiment metrics for A/B testing analysis (currently supports email experiments only)
4953

5054
## Journeys (2 tools)
5155
- **get_journeys**: Get journeys (workflows) with optional pagination and state filtering
52-
- **trigger_journey** 🔒✏️: Trigger a journey (workflow) for a user
56+
- **trigger_journey** 🔒✏️✉️: Trigger a journey (workflow) for a user
5357

5458
## Lists (8 tools)
5559
- **create_list** ✏️: Create a new user list
@@ -72,12 +76,12 @@
7276
- **get_embedded_messages** 🔒: Get embedded messages for a user, grouped by placement ID
7377
- **get_in_app_messages** 🔒: Get in-app messages for a user
7478
- **get_message_types**: Get all message types within the project for use in templates
75-
- **send_email** 🔒✏️: Send email to user
76-
- **send_in_app** 🔒✏️: Send in-app message to user
77-
- **send_push** 🔒✏️: Send push notification to user
78-
- **send_sms** 🔒✏️: Send SMS message to user
79-
- **send_web_push** 🔒✏️: Send web push notification to user
80-
- **send_whatsapp** 🔒✏️: Send WhatsApp message to user
79+
- **send_email** 🔒✏️✉️: Send email to user
80+
- **send_in_app** 🔒✏️✉️: Send in-app message to user
81+
- **send_push** 🔒✏️✉️: Send push notification to user
82+
- **send_sms** 🔒✏️✉️: Send SMS message to user
83+
- **send_web_push** 🔒✏️✉️: Send web push notification to user
84+
- **send_whatsapp** 🔒✏️✉️: Send WhatsApp message to user
8185

8286
## Snippets (5 tools)
8387
- **create_snippet** ✏️: Create a new snippet with Handlebars templating support
@@ -103,10 +107,10 @@
103107
- **get_templates**: Retrieve templates
104108
- **preview_email_template**: Preview email template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted.
105109
- **preview_inapp_template**: Preview in-app message template with custom data. Returns fully rendered HTML with user, event, and/or data feed data substituted.
106-
- **send_email_template_proof** 🔒✏️: Send a proof of a email template to a specific user
107-
- **send_inapp_template_proof** 🔒✏️: Send a proof of a in-app message template to a specific user
108-
- **send_push_template_proof** 🔒✏️: Send a proof of a push notification template to a specific user
109-
- **send_sms_template_proof** 🔒✏️: Send a proof of a SMS template to a specific user
110+
- **send_email_template_proof** 🔒✏️✉️: Send a proof of a email template to a specific user
111+
- **send_inapp_template_proof** 🔒✏️✉️: Send a proof of a in-app message template to a specific user
112+
- **send_push_template_proof** 🔒✏️✉️: Send a proof of a push notification template to a specific user
113+
- **send_sms_template_proof** 🔒✏️✉️: Send a proof of a SMS template to a specific user
110114
- **update_email_template** ✏️: Update existing email template by templateId
111115
- **update_inapp_template** ✏️: Update existing in-app message template by templateId
112116
- **update_push_template** ✏️: Update existing push notification template by templateId

scripts/update-tools.js

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
import { readFileSync, writeFileSync } from "fs";
22
import { TOOL_CREATORS_BY_CATEGORY } from "../dist/tools/index.js";
3-
import { NON_PII_TOOLS, READ_ONLY_TOOLS } from "../dist/tool-filter.js";
3+
import {
4+
NON_PII_TOOLS,
5+
READ_ONLY_TOOLS,
6+
SEND_TOOLS,
7+
} from "../dist/tool-filter.js";
48

59
const TOOLS_FILE = "TOOLS.md";
610

@@ -20,14 +24,19 @@ try {
2024
let icons = "";
2125
if (!NON_PII_TOOLS.has(toolName)) icons += "🔒";
2226
if (!READ_ONLY_TOOLS.has(toolName)) icons += "✏️";
27+
if (SEND_TOOLS.has(toolName)) icons += "✉️";
2328
return icons ? ` ${icons}` : "";
2429
};
2530

2631
const newContent =
2732
[
2833
`# Available Iterable MCP Tools (${totalToolCount} tools)`,
2934
``,
30-
`**Legend:** 🔒 = Contains PII, ✏️ = Write operation`,
35+
`**Legend:**`,
36+
`- 🔒 = Requires enabling user PII access`,
37+
`- ✏️ = Requires enabling writes`,
38+
`- ✉️ = Requires enabling sends`,
39+
``,
3140
...toolsByCategory.flatMap(({ category, tools }) => [
3241
`\n## ${category} (${tools.length} tools)`,
3342
...tools.map(

0 commit comments

Comments
 (0)