buildin.ts•2.68 kB
import { z } from 'zod';
import { McpTool } from '../../../../types';
// 工具名称类型
export type imBuiltinToolName = 'im.builtin.batchSend';
export const larkImBuiltinBatchSendTool: McpTool = {
project: 'im',
name: 'im.builtin.batchSend',
accessTokens: ['tenant'],
description: '[飞书/Lark] - 批量发送消息 - 支持给多个用户、部门批量发送消息，支持文本和卡片',
schema: {
data: z.object({
msg_type: z
.enum(['text', 'post', 'image', 'interactive', 'share_chat'])
.describe(
'消息类型,如果 msg_type 取值为 text、image、post 或者 share_chat，则消息内容需要传入 content 参数内。如果 msg_type 取值为 interactive，则消息内容需要传入 card 参数内。富文本类型（post）的消息，不支持使用 md 标签。',
),
content: z
.any()
.describe(
'消息内容，JSON 结构。该参数的取值与 msg_type 对应，例如 msg_type 取值为 text，则该参数需要传入文本类型的内容。',
)
.optional(),
card: z
.any()
.describe(
'卡片内容，JSON 结构。该参数的取值与 msg_type 对应，仅当 msg_type 取值为 interactive 时，需要将卡片内容传入当前参数。当 msg_type 取值不为 interactive 时，消息内容需要传入到 content 参数。',
)
.optional(),
open_ids: z.array(z.string()).describe('接收者open_id列表').optional(),
user_ids: z.array(z.string()).describe('接收者user_id列表').optional(),
union_ids: z.array(z.string()).describe('接收者union_id列表').optional(),
department_ids: z
.array(z.string())
.describe('部门 ID 列表。列表内支持传入部门 department_id 和 open_department_id')
.optional(),
}),
},
customHandler: async (client, params): Promise<any> => {
try {
const { data } = params;
const response = await client.request({
method: 'POST',
url: '/open-apis/message/v4/batch_send',
data,
});
return {
content: [
{
type: 'text' as const,
text: `批量发送消息请求成功: ${JSON.stringify(response.data ?? response)}`,
},
],
};
} catch (error) {
return {
isError: true,
content: [
{
type: 'text' as const,
text: `批量发送消息请求失败: ${JSON.stringify((error as any)?.response?.data || error)}`,
},
],
};
}
},
};
export const imBuiltinTools = [larkImBuiltinBatchSendTool];