convertkit-automation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

ConvertKit (Kit) Automation via Rube MCP

通过Rube MCP实现ConvertKit（Kit）自动化

Automate ConvertKit (now known as Kit) email marketing operations through Composio's Kit toolkit via Rube MCP.

通过Composio的Kit工具包，借助Rube MCP自动化ConvertKit（现称为Kit）的邮件营销操作。

Prerequisites

前提条件

Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
Active Kit connection via
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
kit
```
Always call
```
RUBE_SEARCH_TOOLS
```
first to get current tool schemas

必须已连接Rube MCP（需具备RUBE_SEARCH_TOOLS功能）
通过
```
RUBE_MANAGE_CONNECTIONS
```
激活Kit连接，工具包为
```
kit
```
请始终先调用
```
RUBE_SEARCH_TOOLS
```
以获取最新的工具架构

Setup

设置步骤

Get Rube MCP: Add

https://rube.app/mcp

as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

Verify Rube MCP is available by confirming
```
RUBE_SEARCH_TOOLS
```
responds
Call
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
kit
```
If connection is not ACTIVE, follow the returned auth link to complete Kit authentication
Confirm connection status shows ACTIVE before running any workflows

获取Rube MCP：在客户端配置中添加

https://rube.app/mcp

作为MCP服务器。无需API密钥 —— 只需添加端点即可使用。

通过确认
```
RUBE_SEARCH_TOOLS
```
能正常响应，验证Rube MCP是否可用
调用
```
RUBE_MANAGE_CONNECTIONS
```
，指定工具包为
```
kit
```
如果连接状态未激活，请按照返回的认证链接完成Kit认证
在运行任何工作流之前，确认连接状态显示为ACTIVE

Core Workflows

核心工作流

1. List and Search Subscribers

1. 列出并搜索订阅者

When to use: User wants to browse, search, or filter email subscribers

Tool sequence:

```
KIT_LIST_SUBSCRIBERS
```
- List subscribers with filters and pagination [Required]

Key parameters:

```
status
```
: Filter by status ('active' or 'inactive')
```
email_address
```
: Exact email to search for
```
created_after
```
/
```
created_before
```
: Date range filter (YYYY-MM-DD)
```
updated_after
```
/
```
updated_before
```
: Date range filter (YYYY-MM-DD)
```
sort_field
```
: Sort by 'id', 'cancelled_at', or 'updated_at'
```
sort_order
```
: 'asc' or 'desc'
```
per_page
```
: Results per page (min 1)
```
after
```
/
```
before
```
: Cursor strings for pagination
```
include_total_count
```
: Set to 'true' to get total subscriber count

Pitfalls:

If
```
sort_field
```
is 'cancelled_at', the
```
status
```
must be set to 'cancelled'
Date filters use YYYY-MM-DD format (no time component)
```
email_address
```
is an exact match; partial email search is not supported
Pagination uses cursor-based approach with
```
after
```
/
```
before
```
cursor strings
```
include_total_count
```
is a string 'true', not a boolean

适用场景：用户想要浏览、搜索或筛选邮件订阅者

工具序列:

```
KIT_LIST_SUBSCRIBERS
```
- 使用筛选条件和分页功能列出订阅者 [必填]

关键参数:

```
status
```
: 按状态筛选（'active'或'inactive'）
```
email_address
```
: 精确搜索的邮箱地址
```
created_after
```
/
```
created_before
```
: 日期范围筛选（格式：YYYY-MM-DD）
```
updated_after
```
/
```
updated_before
```
: 日期范围筛选（格式：YYYY-MM-DD）
```
sort_field
```
: 排序字段（'id'、'cancelled_at'或'updated_at'）
```
sort_order
```
: 排序顺序（'asc'或'desc'）
```
per_page
```
: 每页结果数（最小值1）
```
after
```
/
```
before
```
: 用于分页的游标字符串
```
include_total_count
```
: 设置为'true'以获取订阅者总数

注意事项:

如果
```
sort_field
```
设为'cancelled_at'，则
```
status
```
必须设为'cancelled'
日期筛选使用YYYY-MM-DD格式（不包含时间部分）
```
email_address
```
为精确匹配；不支持邮箱部分搜索
分页采用基于游标的方式，使用
```
after
```
/
```
before
```
游标字符串
```
include_total_count
```
是字符串'true'，而非布尔值

2. Manage Subscriber Tags

2. 管理订阅者标签

When to use: User wants to tag subscribers for segmentation

Tool sequence:

```
KIT_LIST_SUBSCRIBERS
```
- Find subscriber ID by email [Prerequisite]
```
KIT_TAG_SUBSCRIBER
```
- Associate a subscriber with a tag [Required]
```
KIT_LIST_TAG_SUBSCRIBERS
```
- List subscribers for a specific tag [Optional]

Key parameters for tagging:

```
tag_id
```
: Numeric tag ID (required)
```
subscriber_id
```
: Numeric subscriber ID (required)

Pitfalls:

Both
```
tag_id
```
and
```
subscriber_id
```
must be positive integers
Tag IDs must reference existing tags; tags are created via the Kit web UI
Tagging an already-tagged subscriber is idempotent (no error)
Subscriber IDs are returned from LIST_SUBSCRIBERS; use
```
email_address
```
filter to find specific subscribers

适用场景：用户想要为订阅者添加标签以进行细分

工具序列:

```
KIT_LIST_SUBSCRIBERS
```
- 通过邮箱查找订阅者ID [前提步骤]
```
KIT_TAG_SUBSCRIBER
```
- 为订阅者关联标签 [必填]
```
KIT_LIST_TAG_SUBSCRIBERS
```
- 列出特定标签下的所有订阅者 [可选]

标签管理的关键参数:

```
tag_id
```
: 数字标签ID（必填）
```
subscriber_id
```
: 数字订阅者ID（必填）

注意事项:

```
tag_id
```
和
```
subscriber_id
```
必须为正整数
标签ID必须指向已存在的标签；标签需通过Kit网页界面创建
为已添加标签的订阅者再次添加标签是幂等操作（不会报错）
订阅者ID可从LIST_SUBSCRIBERS的响应中获取；使用
```
email_address
```
筛选条件查找特定订阅者

3. Unsubscribe a Subscriber

3. 取消订阅者订阅

When to use: User wants to unsubscribe a subscriber from all communications

Tool sequence:

```
KIT_LIST_SUBSCRIBERS
```
- Find subscriber ID [Prerequisite]
```
KIT_DELETE_SUBSCRIBER
```
- Unsubscribe the subscriber [Required]

Key parameters:

```
id
```
: Subscriber ID (required, positive integer)

Pitfalls:

This permanently unsubscribes the subscriber from ALL email communications
The subscriber's historical data is retained but they will no longer receive emails
Operation is idempotent; unsubscribing an already-unsubscribed subscriber succeeds without error
Returns empty response (HTTP 204 No Content) on success
Subscriber ID must exist; non-existent IDs return 404

适用场景：用户想要让订阅者取消所有通信订阅

工具序列:

```
KIT_LIST_SUBSCRIBERS
```
- 查找订阅者ID [前提步骤]
```
KIT_DELETE_SUBSCRIBER
```
- 取消订阅者的订阅 [必填]

关键参数:

```
id
```
: 订阅者ID（必填，正整数）

注意事项:

此操作会永久取消订阅者的所有邮件通信订阅
订阅者的历史数据会被保留，但他们将不再收到邮件
操作是幂等的；为已取消订阅的订阅者再次执行操作会成功且无报错
成功时返回空响应（HTTP 204 No Content）
订阅者ID必须存在；不存在的ID会返回404错误

4. List and View Broadcasts

4. 列出并查看广播

When to use: User wants to browse email broadcasts or get details of a specific one

Tool sequence:

```
KIT_LIST_BROADCASTS
```
- List all broadcasts with pagination [Required]
```
KIT_GET_BROADCAST
```
- Get detailed information for a specific broadcast [Optional]
```
KIT_GET_BROADCAST_STATS
```
- Get performance statistics for a broadcast [Optional]

Key parameters for listing:

```
per_page
```
: Results per page (1-500)
```
after
```
/
```
before
```
: Cursor strings for pagination
```
include_total_count
```
: Set to 'true' for total count

Key parameters for details:

```
id
```
: Broadcast ID (required, positive integer)

Pitfalls:

```
per_page
```
max is 500 for broadcasts
Broadcast stats are only available for sent broadcasts
Draft broadcasts will not have stats
Broadcast IDs are numeric integers

适用场景：用户想要浏览邮件广播或获取特定广播的详情

工具序列:

```
KIT_LIST_BROADCASTS
```
- 分页列出所有广播 [必填]
```
KIT_GET_BROADCAST
```
- 获取特定广播的详细信息 [可选]
```
KIT_GET_BROADCAST_STATS
```
- 获取广播的性能统计数据 [可选]

列出广播的关键参数:

```
per_page
```
: 每页结果数（1-500）
```
after
```
/
```
before
```
: 用于分页的游标字符串
```
include_total_count
```
: 设置为'true'以获取总数

获取详情的关键参数:

```
id
```
: 广播ID（必填，正整数）

注意事项:

广播的
```
per_page
```
最大值为500
仅已发送的广播有统计数据
草稿广播没有统计数据
广播ID为数字整数

5. Delete a Broadcast

5. 删除广播

When to use: User wants to permanently remove a broadcast

Tool sequence:

```
KIT_LIST_BROADCASTS
```
- Find the broadcast to delete [Prerequisite]
```
KIT_GET_BROADCAST
```
- Verify it is the correct broadcast [Optional]
```
KIT_DELETE_BROADCAST
```
- Permanently delete the broadcast [Required]

Key parameters:

```
id
```
: Broadcast ID (required)

Pitfalls:

Deletion is permanent and cannot be undone
Deleting a sent broadcast removes it but does not unsend the emails
Confirm the broadcast ID before deleting

适用场景：用户想要永久删除某个广播

工具序列:

```
KIT_LIST_BROADCASTS
```
- 找到要删除的广播 [前提步骤]
```
KIT_GET_BROADCAST
```
- 确认是要删除的广播 [可选]
```
KIT_DELETE_BROADCAST
```
- 永久删除广播 [必填]

关键参数:

```
id
```
: 广播ID（必填）

注意事项:

删除操作是永久性的，无法撤销
删除已发送的广播会移除该记录，但不会撤回已发送的邮件
删除前请确认广播ID正确

Common Patterns

常见模式

Subscriber Lookup by Email

通过邮箱查找订阅者

1. Call KIT_LIST_SUBSCRIBERS with email_address='user@example.com'
2. Extract subscriber ID from the response
3. Use ID for tagging, unsubscribing, or other operations

1. 调用KIT_LIST_SUBSCRIBERS with email_address='user@example.com'
2. Extract subscriber ID from the response
3. Use ID for tagging, unsubscribing, or other operations

Pagination

分页处理

Kit uses cursor-based pagination:

Check response for
```
after
```
cursor value
Pass cursor as
```
after
```
parameter in next request
Continue until no more cursor is returned
Use
```
include_total_count: 'true'
```
to track progress

Kit采用基于游标的分页方式:

检查响应中的
```
after
```
游标值
Pass cursor as
```
after
```
parameter in next request
Continue until no more cursor is returned
Use
```
include_total_count: 'true'
```
to track progress

Tag-Based Segmentation

基于标签的细分

1. Create tags in Kit web UI
2. Use KIT_TAG_SUBSCRIBER to assign tags to subscribers
3. Use KIT_LIST_TAG_SUBSCRIBERS to view subscribers per tag

1. Create tags in Kit web UI
2. Use KIT_TAG_SUBSCRIBER to assign tags to subscribers
3. Use KIT_LIST_TAG_SUBSCRIBERS to view subscribers per tag

Known Pitfalls

已知注意事项

ID Formats:

Subscriber IDs: positive integers (e.g., 3887204736)
Tag IDs: positive integers
Broadcast IDs: positive integers
All IDs are numeric, not strings

Status Values:

Subscriber statuses: 'active', 'inactive', 'cancelled'
Some operations are restricted by status (e.g., sorting by cancelled_at requires status='cancelled')

String vs Boolean Parameters:

```
include_total_count
```
is a string 'true', not a boolean true
```
sort_order
```
is a string enum: 'asc' or 'desc'

Rate Limits:

Kit API has per-account rate limits
Implement backoff on 429 responses
Bulk operations should be paced appropriately

Response Parsing:

Response data may be nested under
```
data
```
or
```
data.data
```
Parse defensively with fallback patterns
Cursor values are opaque strings; use exactly as returned

ID格式:

订阅者ID: 正整数（例如：3887204736）
标签ID: 正整数
广播ID: 正整数
所有ID均为数字，而非字符串

状态值:

订阅者状态: 'active', 'inactive', 'cancelled'
某些操作受状态限制（例如：按cancelled_at排序需要status='cancelled'）

字符串与布尔参数:

```
include_total_count
```
是字符串'true'，而非布尔值true
```
sort_order
```
是字符串枚举值: 'asc'或'desc'

速率限制:

Kit API有每个账户的速率限制
收到429响应时请实现退避机制
批量操作应适当控制节奏

响应解析:

响应数据可能嵌套在
```
data
```
或
```
data.data
```
下
请使用防御性解析方式并包含回退逻辑
游标值是不透明字符串；请完全按照返回值使用

Quick Reference

快速参考

Task	Tool Slug	Key Params
List subscribers	KIT_LIST_SUBSCRIBERS	status, email_address, per_page
Tag subscriber	KIT_TAG_SUBSCRIBER	tag_id, subscriber_id
List tag subscribers	KIT_LIST_TAG_SUBSCRIBERS	tag_id
Unsubscribe	KIT_DELETE_SUBSCRIBER	id
List broadcasts	KIT_LIST_BROADCASTS	per_page, after
Get broadcast	KIT_GET_BROADCAST	id
Get broadcast stats	KIT_GET_BROADCAST_STATS	id
Delete broadcast	KIT_DELETE_BROADCAST	id

任务	工具标识	关键参数
列出订阅者	KIT_LIST_SUBSCRIBERS	status, email_address, per_page
为订阅者添加标签	KIT_TAG_SUBSCRIBER	tag_id, subscriber_id
列出标签下的订阅者	KIT_LIST_TAG_SUBSCRIBERS	tag_id
取消订阅	KIT_DELETE_SUBSCRIBER	id
列出广播	KIT_LIST_BROADCASTS	per_page, after
获取广播详情	KIT_GET_BROADCAST	id
获取广播统计数据	KIT_GET_BROADCAST_STATS	id
删除广播	KIT_DELETE_BROADCAST	id