@danyow/lark-mcp 0.5.1

package/dist/mcp-tool/tools/index.d.ts

@@ -0,0 +1,104 @@
+import { BuiltinToolName } from './en/builtin-tools';
+import { ToolName as GenToolName, ProjectName as GenProjectName } from './en/gen-tools';
+export type ToolName = GenToolName | BuiltinToolName;
+export type ProjectName = GenProjectName;
+export declare const AllTools: (import("..").McpTool | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: string[];
+    schema: {};
+} | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: undefined;
+    schema: {
+        data: import("zod").ZodObject<{
+            app_id: import("zod").ZodString;
+            app_secret: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            app_id: string;
+            app_secret: string;
+        }, {
+            app_id: string;
+            app_secret: string;
+        }>;
+    };
+} | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: undefined;
+    schema: {
+        data: import("zod").ZodObject<{
+            app_access_token: import("zod").ZodString;
+            tenant_key: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            app_access_token: string;
+            tenant_key: string;
+        }, {
+            app_access_token: string;
+            tenant_key: string;
+        }>;
+    };
+})[];
+export declare const AllToolsZh: (import("..").McpTool | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: string[];
+    schema: {};
+} | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: undefined;
+    schema: {
+        data: import("zod").ZodObject<{
+            app_id: import("zod").ZodString;
+            app_secret: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            app_id: string;
+            app_secret: string;
+        }, {
+            app_id: string;
+            app_secret: string;
+        }>;
+    };
+} | {
+    project: string;
+    name: string;
+    sdkName: string;
+    path: string;
+    httpMethod: string;
+    description: string;
+    accessTokens: undefined;
+    schema: {
+        data: import("zod").ZodObject<{
+            app_access_token: import("zod").ZodString;
+            tenant_key: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            app_access_token: string;
+            tenant_key: string;
+        }, {
+            app_access_token: string;
+            tenant_key: string;
+        }>;
+    };
+})[];

package/dist/mcp-tool/tools/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AllToolsZh = exports.AllTools = void 0;
+const builtin_tools_1 = require("./en/builtin-tools");
+const builtin_tools_2 = require("./zh/builtin-tools");
+const gen_tools_1 = require("./en/gen-tools");
+const gen_tools_2 = require("./zh/gen-tools");
+exports.AllTools = [...gen_tools_1.GenTools, ...builtin_tools_1.BuiltinTools];
+exports.AllToolsZh = [...gen_tools_2.GenTools, ...builtin_tools_2.BuiltinTools];

package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.d.ts

@@ -0,0 +1,5 @@
+import { McpTool } from '../../../../types';
+export type docxBuiltinToolName = 'docx.builtin.search' | 'docx.builtin.import';
+export declare const larkDocxBuiltinSearchTool: McpTool;
+export declare const larkDocxBuiltinImportTool: McpTool;
+export declare const docxBuiltinTools: McpTool[];

package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.js

@@ -0,0 +1,198 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docxBuiltinTools = exports.larkDocxBuiltinImportTool = exports.larkDocxBuiltinSearchTool = void 0;
+const lark = __importStar(require("@larksuiteoapi/node-sdk"));
+const stream_1 = require("stream");
+const zod_1 = require("zod");
+exports.larkDocxBuiltinSearchTool = {
+    project: 'docx',
+    name: 'docx.builtin.search',
+    accessTokens: ['user'],
+    description: '[飞书/Lark] - 云文档-文档 - 搜索文档 - 搜索云文档，只支持user_access_token',
+    schema: {
+        data: zod_1.z.object({
+            search_key: zod_1.z.string().describe('搜索关键词'),
+            count: zod_1.z.number().describe('指定搜索返回的文件数量。取值范围为 [0,50]。').optional(),
+            offset: zod_1.z
+                .number()
+                .describe('指定搜索的偏移量，该参数最小为 0，即不偏移。该参数的值与返回的文件数量之和不得大于或等于 200（即 offset + count < 200）。')
+                .optional(),
+            owner_ids: zod_1.z.array(zod_1.z.string()).describe('文件所有者的 Open ID').optional(),
+            chat_ids: zod_1.z.array(zod_1.z.string()).describe('文件所在群的 ID').optional(),
+            docs_types: zod_1.z
+                .array(zod_1.z.enum(['doc', 'sheet', 'slides', 'bitable', 'mindnote', 'file']))
+                .describe('文件类型，支持以下枚举：doc：旧版文档;sheet：电子表格;slides：幻灯片;bitable：多维表格;mindnote：思维笔记;file：文件')
+                .optional(),
+        }),
+        useUAT: zod_1.z.boolean().describe('是否使用用户身份请求，false则使用应用身份请求').optional(),
+    },
+    customHandler: async (client, params, options) => {
+        var _a;
+        try {
+            const { userAccessToken } = options || {};
+            if (!userAccessToken) {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({ msg: '当前未配置 userAccessToken' }) }],
+                };
+            }
+            const response = await client.request({
+                method: 'POST',
+                url: '/open-apis/suite/docs-api/search/object',
+                data: params.data,
+            }, lark.withUserAccessToken(userAccessToken));
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify((_a = response.data) !== null && _a !== void 0 ? _a : response),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                isError: true,
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(error.response.data),
+                    },
+                ],
+            };
+        }
+    },
+};
+exports.larkDocxBuiltinImportTool = {
+    project: 'docx',
+    name: 'docx.builtin.import',
+    accessTokens: ['user', 'tenant'],
+    description: '[飞书/Lark] - 云文档-文档 - 导入文档 - 导入云文档，最大20MB',
+    schema: {
+        data: zod_1.z
+            .object({
+            markdown: zod_1.z.string().describe('markdown文件内容'),
+            file_name: zod_1.z.string().describe('文件名').max(27).optional(),
+        })
+            .describe('请求体'),
+        useUAT: zod_1.z.boolean().describe('使用用户身份请求，否则为应用身份').optional(),
+    },
+    customHandler: async (client, params, options) => {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        try {
+            const { userAccessToken } = options || {};
+            const file = stream_1.Readable.from(params.data.markdown);
+            const data = {
+                file_name: 'docx.md',
+                parent_type: 'ccm_import_open',
+                parent_node: '/',
+                size: Buffer.byteLength(params.data.markdown),
+                file,
+                extra: JSON.stringify({ obj_type: 'docx', file_extension: 'md' }),
+            };
+            const response = userAccessToken && params.useUAT
+                ? await client.drive.media.uploadAll({ data }, lark.withUserAccessToken(userAccessToken))
+                : await client.drive.media.uploadAll({ data });
+            if (!(response === null || response === void 0 ? void 0 : response.file_token)) {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({ msg: '导入文档失败，请检查markdown文件内容' }) }],
+                };
+            }
+            const importData = {
+                file_extension: 'md',
+                file_name: params.data.file_name,
+                file_token: response === null || response === void 0 ? void 0 : response.file_token,
+                type: 'docx',
+                point: {
+                    mount_type: 1,
+                    mount_key: '',
+                },
+            };
+            const importResponse = userAccessToken && params.useUAT
+                ? await client.drive.importTask.create({ data: importData }, lark.withUserAccessToken(userAccessToken))
+                : await client.drive.importTask.create({ data: importData });
+            const taskId = (_a = importResponse.data) === null || _a === void 0 ? void 0 : _a.ticket;
+            if (!taskId) {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({ msg: '导入文档失败，请检查markdown文件内容' }) }],
+                };
+            }
+            for (let i = 0; i < 5; i++) {
+                const taskResponse = userAccessToken && params.useUAT
+                    ? await client.drive.importTask.get({ path: { ticket: taskId } }, lark.withUserAccessToken(userAccessToken))
+                    : await client.drive.importTask.get({ path: { ticket: taskId } });
+                if (((_c = (_b = taskResponse.data) === null || _b === void 0 ? void 0 : _b.result) === null || _c === void 0 ? void 0 : _c.job_status) === 0) {
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: JSON.stringify((_d = taskResponse.data) !== null && _d !== void 0 ? _d : taskResponse),
+                            },
+                        ],
+                    };
+                }
+                else if (((_f = (_e = taskResponse.data) === null || _e === void 0 ? void 0 : _e.result) === null || _f === void 0 ? void 0 : _f.job_status) !== 1 && ((_h = (_g = taskResponse.data) === null || _g === void 0 ? void 0 : _g.result) === null || _h === void 0 ? void 0 : _h.job_status) !== 2) {
+                    return {
+                        content: [{ type: 'text', text: JSON.stringify(taskResponse.data) }],
+                    };
+                }
+                await new Promise((resolve) => setTimeout(resolve, 1000));
+            }
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify({ msg: '导入文档失败，请稍后再试' }),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                isError: true,
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(((_j = error === null || error === void 0 ? void 0 : error.response) === null || _j === void 0 ? void 0 : _j.data) || error),
+                    },
+                ],
+            };
+        }
+    },
+};
+exports.docxBuiltinTools = [exports.larkDocxBuiltinSearchTool, exports.larkDocxBuiltinImportTool];

package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.d.ts

@@ -0,0 +1,4 @@
+import { McpTool } from '../../../../types';
+export type driveBuiltinToolName = 'drive.v1.exportTask.download';
+export declare const larkDriveExportTaskDownloadTool: McpTool;
+export declare const driveBuiltinTools: McpTool[];

package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.js

@@ -0,0 +1,159 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.driveBuiltinTools = exports.larkDriveExportTaskDownloadTool = void 0;
+const lark = __importStar(require("@larksuiteoapi/node-sdk"));
+const zod_1 = require("zod");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const os = __importStar(require("os"));
+exports.larkDriveExportTaskDownloadTool = {
+    project: 'drive',
+    name: 'drive.v1.exportTask.download',
+    sdkName: 'drive.v1.exportTask.download',
+    path: '/open-apis/drive/v1/export_tasks/file/:file_token/download',
+    httpMethod: 'GET',
+    accessTokens: ['user', 'tenant'],
+    supportFileDownload: true,
+    description: '[飞书/Lark]-云文档-云空间-文件-导出文档-下载导出文件-使用导出任务返回的 file_token 下载导出的文件。文件将保存到指定的输出目录，并返回本地文件路径。注意：导出的文件将在导出任务完成后 10 分钟内被删除。',
+    schema: {
+        path: zod_1.z.object({
+            file_token: zod_1.z
+                .string()
+                .describe('从导出任务（drive.v1.exportTask.get）返回的文件令牌。此令牌用于下载导出的文件。'),
+        }),
+        params: zod_1.z.object({
+            output_dir: zod_1.z
+                .string()
+                .describe('下载文件的保存目录。如果未指定，默认使用系统临时目录。')
+                .optional(),
+            file_name: zod_1.z
+                .string()
+                .describe('下载文件的名称（包含扩展名，例如 "document.xlsx"）。如果未指定，使用导出任务中的原始文件名。')
+                .optional(),
+        }).optional(),
+        useUAT: zod_1.z.boolean().describe('使用用户访问令牌，否则使用租户访问令牌').optional(),
+    },
+    customHandler: async (client, params, options) => {
+        var _a, _b, _c, _d;
+        try {
+            const { userAccessToken } = options || {};
+            const fileToken = (_a = params === null || params === void 0 ? void 0 : params.path) === null || _a === void 0 ? void 0 : _a.file_token;
+            if (!fileToken) {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({ msg: 'file_token 是必需的' }) }],
+                };
+            }
+            // Determine output directory and filename
+            const outputDir = ((_b = params === null || params === void 0 ? void 0 : params.params) === null || _b === void 0 ? void 0 : _b.output_dir) || os.tmpdir();
+            const fileName = ((_c = params === null || params === void 0 ? void 0 : params.params) === null || _c === void 0 ? void 0 : _c.file_name) || `export_${fileToken}`;
+            // Ensure output directory exists
+            if (!fs.existsSync(outputDir)) {
+                fs.mkdirSync(outputDir, { recursive: true });
+            }
+            const filePath = path.join(outputDir, fileName);
+            // Use SDK's built-in download method which returns writeFile/getReadableStream
+            let response;
+            if (userAccessToken && (params === null || params === void 0 ? void 0 : params.useUAT)) {
+                response = await client.drive.exportTask.download({ path: { file_token: fileToken } }, lark.withUserAccessToken(userAccessToken));
+            }
+            else {
+                response = await client.drive.exportTask.download({ path: { file_token: fileToken } });
+            }
+            // Use the SDK's writeFile method to save the file
+            if (response === null || response === void 0 ? void 0 : response.writeFile) {
+                await response.writeFile(filePath);
+            }
+            else if (response === null || response === void 0 ? void 0 : response.getReadableStream) {
+                // Fallback to stream if writeFile is not available
+                const readableStream = response.getReadableStream();
+                const writableStream = fs.createWriteStream(filePath);
+                await new Promise((resolve, reject) => {
+                    readableStream.pipe(writableStream);
+                    writableStream.on('finish', resolve);
+                    writableStream.on('error', reject);
+                    readableStream.on('error', reject);
+                });
+            }
+            else {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({
+                                msg: '下载文件失败：SDK 响应不包含 writeFile 或 getReadableStream',
+                                debug: { responseKeys: response ? Object.keys(response) : [] }
+                            }) }],
+                };
+            }
+            // Check if file was created and get stats
+            if (!fs.existsSync(filePath)) {
+                return {
+                    isError: true,
+                    content: [{ type: 'text', text: JSON.stringify({ msg: '下载文件失败：文件未创建' }) }],
+                };
+            }
+            const stats = fs.statSync(filePath);
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify({
+                            success: true,
+                            file_path: filePath,
+                            file_name: fileName,
+                            file_size: stats.size,
+                            message: `文件下载成功，保存至 ${filePath}`,
+                        }),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                isError: true,
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify({
+                            msg: '下载导出文件失败',
+                            error: ((_d = error === null || error === void 0 ? void 0 : error.response) === null || _d === void 0 ? void 0 : _d.data) || (error === null || error === void 0 ? void 0 : error.message) || String(error),
+                        }),
+                    },
+                ],
+            };
+        }
+    },
+};
+exports.driveBuiltinTools = [exports.larkDriveExportTaskDownloadTool];

package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.d.ts

@@ -0,0 +1,4 @@
+import { McpTool } from '../../../../types';
+export type imBuiltinToolName = 'im.builtin.batchSend';
+export declare const larkImBuiltinBatchSendTool: McpTool;
+export declare const imBuiltinTools: McpTool[];

package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.imBuiltinTools = exports.larkImBuiltinBatchSendTool = void 0;
+const zod_1 = require("zod");
+exports.larkImBuiltinBatchSendTool = {
+    project: 'im',
+    name: 'im.builtin.batchSend',
+    accessTokens: ['tenant'],
+    description: '[飞书/Lark] - 批量发送消息 - 支持给多个用户、部门批量发送消息，支持文本和卡片',
+    schema: {
+        data: zod_1.z.object({
+            msg_type: zod_1.z
+                .enum(['text', 'post', 'image', 'interactive', 'share_chat'])
+                .describe('消息类型,如果 msg_type 取值为 text、image、post 或者 share_chat，则消息内容需要传入 content 参数内。如果 msg_type 取值为 interactive，则消息内容需要传入 card 参数内。富文本类型（post）的消息，不支持使用 md 标签。'),
+            content: zod_1.z
+                .any()
+                .describe('消息内容，JSON 结构。该参数的取值与 msg_type 对应，例如 msg_type 取值为 text，则该参数需要传入文本类型的内容。')
+                .optional(),
+            card: zod_1.z
+                .any()
+                .describe('卡片内容，JSON 结构。该参数的取值与 msg_type 对应，仅当 msg_type 取值为 interactive 时，需要将卡片内容传入当前参数。当 msg_type 取值不为 interactive 时，消息内容需要传入到 content 参数。')
+                .optional(),
+            open_ids: zod_1.z.array(zod_1.z.string()).describe('接收者open_id列表').optional(),
+            user_ids: zod_1.z.array(zod_1.z.string()).describe('接收者user_id列表').optional(),
+            union_ids: zod_1.z.array(zod_1.z.string()).describe('接收者union_id列表').optional(),
+            department_ids: zod_1.z
+                .array(zod_1.z.string())
+                .describe('部门 ID 列表。列表内支持传入部门 department_id 和 open_department_id')
+                .optional(),
+        }),
+    },
+    customHandler: async (client, params) => {
+        var _a, _b;
+        try {
+            const { data } = params;
+            const response = await client.request({
+                method: 'POST',
+                url: '/open-apis/message/v4/batch_send',
+                data,
+            });
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify((_a = response.data) !== null && _a !== void 0 ? _a : response),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                isError: true,
+                content: [
+                    {
+                        type: 'text',
+                        text: JSON.stringify(((_b = error === null || error === void 0 ? void 0 : error.response) === null || _b === void 0 ? void 0 : _b.data) || error),
+                    },
+                ],
+            };
+        }
+    },
+};
+exports.imBuiltinTools = [exports.larkImBuiltinBatchSendTool];

package/dist/mcp-tool/tools/zh/builtin-tools/index.d.ts

@@ -0,0 +1,5 @@
+import { docxBuiltinToolName } from './docx/builtin';
+import { driveBuiltinToolName } from './drive/builtin';
+import { imBuiltinToolName } from './im/buildin';
+export declare const BuiltinTools: import("../../..").McpTool[];
+export type BuiltinToolName = docxBuiltinToolName | driveBuiltinToolName | imBuiltinToolName;

package/dist/mcp-tool/tools/zh/builtin-tools/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuiltinTools = void 0;
+const builtin_1 = require("./docx/builtin");
+const builtin_2 = require("./drive/builtin");
+const buildin_1 = require("./im/buildin");
+exports.BuiltinTools = [...builtin_1.docxBuiltinTools, ...builtin_2.driveBuiltinTools, ...buildin_1.imBuiltinTools];