@danyow/lark-mcp 0.5.1

package/dist/mcp-tool/utils/filter-tools.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterTools = filterTools;
+const types_1 = require("../types");
+function filterTools(tools, options) {
+    let filteredTools = tools.filter((tool) => {
+        var _a, _b;
+        return ((_a = options.allowTools) === null || _a === void 0 ? void 0 : _a.includes(tool.name)) ||
+            ((_b = options.allowProjects) === null || _b === void 0 ? void 0 : _b.includes(tool.project));
+    });
+    // Filter by token mode
+    if (options.tokenMode && options.tokenMode !== types_1.TokenMode.AUTO) {
+        filteredTools = filteredTools.filter((tool) => {
+            if (!tool.accessTokens) {
+                return false;
+            }
+            if (options.tokenMode === types_1.TokenMode.USER_ACCESS_TOKEN) {
+                return tool.accessTokens.includes('user');
+            }
+            if (options.tokenMode === types_1.TokenMode.TENANT_ACCESS_TOKEN) {
+                return tool.accessTokens.includes('tenant');
+            }
+            return true;
+        });
+    }
+    return filteredTools;
+}

package/dist/mcp-tool/utils/get-should-use-uat.d.ts

@@ -0,0 +1,2 @@
+import { TokenMode } from '../types';
+export declare function getShouldUseUAT(tokenMode?: TokenMode, useUAT?: boolean): boolean | undefined;

package/dist/mcp-tool/utils/get-should-use-uat.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getShouldUseUAT = getShouldUseUAT;
+const types_1 = require("../types");
+function getShouldUseUAT(tokenMode = types_1.TokenMode.AUTO, useUAT) {
+    switch (tokenMode) {
+        case types_1.TokenMode.USER_ACCESS_TOKEN: {
+            return true;
+        }
+        case types_1.TokenMode.TENANT_ACCESS_TOKEN: {
+            return false;
+        }
+        case types_1.TokenMode.AUTO:
+        default: {
+            return useUAT;
+        }
+    }
+}

package/dist/mcp-tool/utils/handler.d.ts

@@ -0,0 +1,2 @@
+import { McpHandler } from '../types';
+export declare const larkOapiHandler: McpHandler;

package/dist/mcp-tool/utils/handler.js

@@ -0,0 +1,119 @@
+"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.larkOapiHandler = void 0;
+const lark = __importStar(require("@larksuiteoapi/node-sdk"));
+const logger_1 = require("../../utils/logger");
+/**
+ * Replace path parameters in URL template
+ * e.g., /open-apis/sheets/v2/spreadsheets/:spreadsheet_token/values/:range
+ * with pathParams { spreadsheet_token: "xxx", range: "yyy" }
+ * becomes /open-apis/sheets/v2/spreadsheets/xxx/values/yyy
+ */
+const fillApiPath = (apiPath, pathParams = {}) => {
+    return apiPath.replace(/:([^/]+)/g, (_, key) => {
+        if (pathParams[key] !== undefined) {
+            return encodeURIComponent(pathParams[key]);
+        }
+        throw new Error(`Missing path parameter: ${key}`);
+    });
+};
+const sdkFuncCall = async (client, params, options) => {
+    const { tool, userAccessToken } = options || {};
+    const { sdkName, path, httpMethod } = tool || {};
+    if (!sdkName) {
+        logger_1.logger.error(`[larkOapiHandler] Invalid sdkName`);
+        throw new Error('Invalid sdkName');
+    }
+    if (!path) {
+        logger_1.logger.error(`[larkOapiHandler] Invalid path`);
+        throw new Error('Invalid path');
+    }
+    const chain = sdkName.split('.');
+    let func = client;
+    for (const element of chain) {
+        func = func[element];
+        if (!func) {
+            // SDK doesn't have this method, use client.request() with path parameter replacement
+            func = async (reqParams, ...args) => {
+                const { path: pathParams, ...restParams } = reqParams || {};
+                const filledPath = fillApiPath(path, pathParams);
+                return await client.request({ method: httpMethod, url: filledPath, ...restParams }, ...args);
+            };
+            break;
+        }
+    }
+    if (!(func instanceof Function)) {
+        func = async (reqParams, ...args) => {
+            const { path: pathParams, ...restParams } = reqParams || {};
+            const filledPath = fillApiPath(path, pathParams);
+            return await client.request({ method: httpMethod, url: filledPath, ...restParams }, ...args);
+        };
+    }
+    if (params === null || params === void 0 ? void 0 : params.useUAT) {
+        if (!userAccessToken) {
+            logger_1.logger.error(`[larkOapiHandler] UserAccessToken is invalid or expired`);
+            throw new Error('UserAccessToken is invalid or expired');
+        }
+        return await func(params, lark.withUserAccessToken(userAccessToken));
+    }
+    return await func(params);
+};
+const larkOapiHandler = async (client, params, options) => {
+    var _a, _b;
+    try {
+        const response = await sdkFuncCall(client, params, options);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify((_a = response === null || response === void 0 ? void 0 : 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 === null || error === void 0 ? void 0 : error.message) || error),
+                },
+            ],
+        };
+    }
+};
+exports.larkOapiHandler = larkOapiHandler;

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

@@ -0,0 +1,4 @@
+export * from './filter-tools';
+export * from './handler';
+export * from './case-transf';
+export * from './get-should-use-uat';

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

@@ -0,0 +1,20 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./filter-tools"), exports);
+__exportStar(require("./handler"), exports);
+__exportStar(require("./case-transf"), exports);
+__exportStar(require("./get-should-use-uat"), exports);

package/dist/utils/clean-env-args.d.ts

@@ -0,0 +1 @@
+export declare function cleanEnvArgs(args: Record<string, string | undefined>): Record<string, string>;

package/dist/utils/clean-env-args.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanEnvArgs = cleanEnvArgs;
+function cleanEnvArgs(args) {
+    const result = {};
+    for (const [key, value] of Object.entries(args)) {
+        if (value) {
+            result[key] = value;
+        }
+    }
+    return result;
+}

package/dist/utils/constants.d.ts

@@ -0,0 +1,18 @@
+import envPaths from 'env-paths';
+export declare const ENV_PATHS: envPaths.Paths;
+export declare const USER_AGENT: string;
+export declare const NODE_VERSION_MAJOR: number;
+export declare const OAPI_MCP_DEFAULT_ARGS: {
+    domain: string;
+    toolNameCase: string;
+    language: string;
+    tokenMode: string;
+    mode: string;
+    host: string;
+    port: string;
+};
+export declare const OAPI_MCP_ENV_ARGS: Record<string, string>;
+export declare enum OAPI_MCP_ERROR_CODE {
+    USER_ACCESS_TOKEN_INVALID = 99991668,
+    USER_ACCESS_TOKEN_UNAUTHORIZED = 99991679
+}

package/dist/utils/constants.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAPI_MCP_ERROR_CODE = exports.OAPI_MCP_ENV_ARGS = exports.OAPI_MCP_DEFAULT_ARGS = exports.NODE_VERSION_MAJOR = exports.USER_AGENT = exports.ENV_PATHS = void 0;
+const clean_env_args_1 = require("./clean-env-args");
+const version_1 = require("./version");
+const env_paths_1 = __importDefault(require("env-paths"));
+exports.ENV_PATHS = (0, env_paths_1.default)('lark-mcp');
+const [major] = process.versions.node.split('.').map(Number);
+exports.USER_AGENT = `oapi-sdk-mcp/${version_1.currentVersion}`;
+exports.NODE_VERSION_MAJOR = major;
+exports.OAPI_MCP_DEFAULT_ARGS = {
+    domain: 'https://open.feishu.cn',
+    toolNameCase: 'snake',
+    language: 'en',
+    tokenMode: 'auto',
+    mode: 'stdio',
+    host: 'localhost',
+    port: '3000',
+};
+exports.OAPI_MCP_ENV_ARGS = (0, clean_env_args_1.cleanEnvArgs)({
+    appId: process.env.APP_ID,
+    appSecret: process.env.APP_SECRET,
+    userAccessToken: process.env.USER_ACCESS_TOKEN,
+    tokenMode: process.env.LARK_TOKEN_MODE,
+    tools: process.env.LARK_TOOLS,
+    domain: process.env.LARK_DOMAIN,
+});
+var OAPI_MCP_ERROR_CODE;
+(function (OAPI_MCP_ERROR_CODE) {
+    OAPI_MCP_ERROR_CODE[OAPI_MCP_ERROR_CODE["USER_ACCESS_TOKEN_INVALID"] = 99991668] = "USER_ACCESS_TOKEN_INVALID";
+    OAPI_MCP_ERROR_CODE[OAPI_MCP_ERROR_CODE["USER_ACCESS_TOKEN_UNAUTHORIZED"] = 99991679] = "USER_ACCESS_TOKEN_UNAUTHORIZED";
+})(OAPI_MCP_ERROR_CODE || (exports.OAPI_MCP_ERROR_CODE = OAPI_MCP_ERROR_CODE = {}));

package/dist/utils/http-instance.d.ts

@@ -0,0 +1,2 @@
+export declare const commonHttpInstance: import("axios").AxiosInstance;
+export declare const oapiHttpInstance: import("axios").AxiosInstance;

package/dist/utils/http-instance.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oapiHttpInstance = exports.commonHttpInstance = void 0;
+const axios_1 = __importDefault(require("axios"));
+const proxy_agent_1 = require("proxy-agent");
+const constants_1 = require("./constants");
+const proxyAgent = new proxy_agent_1.ProxyAgent();
+const traceMiddleware = (request) => {
+    if (request.headers) {
+        request.headers['User-Agent'] = constants_1.USER_AGENT;
+    }
+    return request;
+};
+exports.commonHttpInstance = axios_1.default.create({ proxy: false, httpAgent: proxyAgent, httpsAgent: proxyAgent });
+exports.commonHttpInstance.interceptors.request.use(traceMiddleware, undefined, { synchronous: true });
+exports.oapiHttpInstance = axios_1.default.create({ proxy: false, httpAgent: proxyAgent, httpsAgent: proxyAgent });
+exports.oapiHttpInstance.interceptors.request.use(traceMiddleware, undefined, { synchronous: true });
+exports.oapiHttpInstance.interceptors.response.use((response) => response.data);

package/dist/utils/logger.d.ts

@@ -0,0 +1,22 @@
+export declare enum LogLevel {
+    ERROR = 1,
+    WARN = 2,
+    INFO = 3,
+    DEBUG = 4
+}
+export declare class Logger {
+    private level;
+    static logFilesToKeep: number;
+    static logFilePrefix: string;
+    constructor();
+    get logFileName(): string;
+    initLogFile: () => void;
+    cleanHistoryLogFile: () => void;
+    setLevel: (level: LogLevel) => void;
+    log: (message: string) => void;
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+}
+export declare const logger: Logger;

package/dist/utils/logger.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.Logger = exports.LogLevel = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants");
+const version_1 = require("./version");
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["ERROR"] = 1] = "ERROR";
+    LogLevel[LogLevel["WARN"] = 2] = "WARN";
+    LogLevel[LogLevel["INFO"] = 3] = "INFO";
+    LogLevel[LogLevel["DEBUG"] = 4] = "DEBUG";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+class Logger {
+    constructor() {
+        this.level = LogLevel.WARN;
+        this.initLogFile = () => {
+            if (!fs_1.default.existsSync(constants_1.ENV_PATHS.log)) {
+                fs_1.default.mkdirSync(constants_1.ENV_PATHS.log, { recursive: true });
+            }
+        };
+        this.cleanHistoryLogFile = () => {
+            try {
+                // clean old log files, 7 days ago
+                const logFiles = fs_1.default
+                    .readdirSync(constants_1.ENV_PATHS.log)
+                    .filter((file) => file.startsWith(Logger.logFilePrefix) && file.endsWith('.log'));
+                const logFilesToDelete = logFiles.filter((file) => {
+                    const fileDate = file.split('-')[1].split('.')[0];
+                    const fileDateObj = new Date(fileDate);
+                    return fileDateObj < new Date(Date.now() - Logger.logFilesToKeep * 24 * 60 * 60 * 1000);
+                });
+                for (const file of logFilesToDelete) {
+                    try {
+                        fs_1.default.unlinkSync(path_1.default.join(constants_1.ENV_PATHS.log, file));
+                    }
+                    catch (error) {
+                        console.error(`Failed to delete log file: ${error}`);
+                    }
+                }
+            }
+            catch (error) {
+                console.error(`Failed to clean history log file: ${error}`);
+            }
+        };
+        this.setLevel = (level) => {
+            this.level = level;
+        };
+        this.log = (message) => {
+            try {
+                fs_1.default.appendFileSync(path_1.default.join(constants_1.ENV_PATHS.log, this.logFileName), `[${new Date().toISOString()}] [${version_1.currentVersion}] [${process.pid}] ${message}\n`);
+            }
+            catch (error) {
+                console.error(`Failed to write log: ${error} ${message}`);
+            }
+        };
+        this.debug = (message) => {
+            if (this.level < LogLevel.DEBUG) {
+                return;
+            }
+            this.log(`[DEBUG] ${message}`);
+        };
+        this.info = (message) => {
+            if (this.level < LogLevel.INFO) {
+                return;
+            }
+            this.log(`[INFO] ${message}`);
+        };
+        this.warn = (message) => {
+            if (this.level < LogLevel.WARN) {
+                return;
+            }
+            console.error(`[WARN] ${message}`);
+            this.log(`[WARN] ${message}`);
+        };
+        this.error = (message) => {
+            if (this.level < LogLevel.ERROR) {
+                return;
+            }
+            console.error(`[ERROR] ${message}`);
+            this.log(`[ERROR]  ${message}`);
+        };
+        this.initLogFile();
+        this.cleanHistoryLogFile();
+    }
+    get logFileName() {
+        return `${Logger.logFilePrefix}${new Date().toISOString().split('T')[0]}.log`;
+    }
+}
+exports.Logger = Logger;
+Logger.logFilesToKeep = 7;
+Logger.logFilePrefix = 'lark-mcp-';
+exports.logger = new Logger();

package/dist/utils/noop.d.ts

@@ -0,0 +1 @@
+export declare const noop: () => void;

package/dist/utils/noop.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noop = void 0;
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const noop = () => { };
+exports.noop = noop;

package/dist/utils/parser-string-array.d.ts

@@ -0,0 +1 @@
+export declare function parseStringArray(str?: string | string[]): string[];

package/dist/utils/parser-string-array.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseStringArray = parseStringArray;
+function parseStringArray(str) {
+    if (!str) {
+        return [];
+    }
+    if (typeof str === 'string') {
+        // split by comma or space and trim space
+        return str.split(/[,\s]+/).map((item) => item.trim());
+    }
+    return str.map((item) => item.trim());
+}

package/dist/utils/safe-json-parse.d.ts

@@ -0,0 +1 @@
+export declare function safeJsonParse<T>(str: string | undefined | null, fallback: T): T;

package/dist/utils/safe-json-parse.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeJsonParse = safeJsonParse;
+function safeJsonParse(str, fallback) {
+    if (!str) {
+        return fallback;
+    }
+    try {
+        return JSON.parse(str);
+    }
+    catch (e) {
+        return fallback;
+    }
+}

package/dist/utils/version.d.ts

@@ -0,0 +1 @@
+export declare const currentVersion: string;

package/dist/utils/version.js

@@ -0,0 +1,52 @@
+"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.currentVersion = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const safe_json_parse_1 = require("./safe-json-parse");
+function getPackageJsonVersion() {
+    const filePath = path.join(__dirname, '../../package.json');
+    try {
+        const packageJson = (0, safe_json_parse_1.safeJsonParse)(fs.readFileSync(filePath, 'utf8'), {
+            version: '0.0.0',
+        });
+        return packageJson.version || '0.0.0';
+    }
+    catch (error) {
+        return '0.0.0';
+    }
+}
+exports.currentVersion = getPackageJsonVersion();

package/docs/recall-mcp/README.md

@@ -0,0 +1,137 @@
+# Feishu/Lark Open Platform Developer Documentation Retrieval MCP
+
+[![npm version](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)
+[![npm downloads](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)
+[![Node.js Version](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)
+
+English | [中文](./README_ZH.md)
+
+> **⚠️ Beta Version Notice**: This tool is currently in Beta. Features and APIs may change, so please pay close attention to version updates.
+
+This is the Feishu/Lark official Open Platform Developer Documentation Retrieval MCP (Model Context Protocol) tool, designed to help users quickly find the documentation they need after entering their requirements. It can also be used with [Feishu/Lark OpenAPI MCP](../../README.md) to enable AI assistants to run automated scenarios.
+
+> The scope of documentation retrieval covers all developer guides, tutorials, server-side APIs, and client-side APIs under the [Developer Documentation](https://open.feishu.cn/document/home/index) or [Lark Developer Documentation](https://open.larksuite.com/document/home/index), helping users quickly find the corresponding OpenAPI or other developer documentation. It does not search "Lark Docs" documents.
+
+## Getting Started
+
+### Install Node.js
+
+Before using the lark-mcp tool, you need to install the Node.js environment. If you have already installed Node.js, you can skip this step.
+1. **Install with Homebrew (Recommended):**
+
+   ```bash
+   brew install node
+   ```
+
+2. **Use the official installer:**
+   - Visit the [Node.js official website](https://nodejs.org/)
+   - Download and install the LTS version
+   - After installation, open the terminal to verify:
+     ```bash
+     node -v
+     npm -v
+     ```
+
+#### Install Node.js on Windows
+
+1. **Use the official installer:**
+
+   - Visit the [Node.js official website](https://nodejs.org/)
+   - Download and run the Windows installer (.msi file)
+   - Follow the installation wizard to complete the installation
+   - After installation, open the command prompt to verify:
+     ```bash
+     node -v
+     npm -v
+     ```
+
+2. **Use nvm-windows:**
+   - Download [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)
+   - Install nvm-windows
+   - Use nvm to install Node.js:
+     ```bash
+     nvm install latest
+     nvm use <version>
+     ```
+
+## Installation
+
+Install the lark-mcp tool globally:
+
+```bash
+npm install -g @larksuiteoapi/lark-mcp
+```
+
+## User Guide
+
+### Use in Trae/Cursor/Claude
+To integrate Lark features in AI tools such as Trae, Cursor or Claude, you can install using the button below.
+
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=lark_open_doc_search&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=)
+
+[![Install MCP Server](../../assets/trae-cn.svg)](trae-cn://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=)  [![Install MCP Server](../../assets/trae.svg)](trae://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=)
+
+or you can add the following to your configuration file:
+
+```json
+{
+  "mcpServers": {
+    "lark-mcp": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@larksuiteoapi/lark-mcp",
+        "recall-developer-documents",
+      ]
+    }
+  }
+}
+```
+
+### Advanced Configuration
+
+#### Command Line Arguments
+
+The `lark-mcp recall-developer-documents` tool provides a variety of command line arguments for flexible MCP service configuration:
+
+| Parameter | Short | Description | Example |
+|------|------|------|------|
+| `--mode` | `-m` | Transfer mode, options are stdio or streamable or sse, default is stdio | `-m sse` |
+| `--host` |  | Listening host in SSE\Streamable mode, default is localhost | `--host 0.0.0.0` |
+| `--port` | `-p` | Listening port in SSE\Streamable mode, default is 3000 | `-p 3000` |
+| `--version` | `-V` | Show version number | `-V` |
+| `--help` | `-h` | Show help information | `-h` |
+
+#### Example Usage of Arguments
+
+1. **Transfer Modes**：
+
+    recall-developer-documents supports two transfer modes:
+
+    1. **stdio mode (default/recommended):** Suitable for integration with AI tools such as Cursor or Claude, communicating via standard input and output streams.
+      ```bash
+      lark-mcp recall-developer-documents -m stdio
+      ```
+
+    2. **SSE mode:** Provides an HTTP interface based on Server-Sent Events, suitable for web applications or scenarios requiring a network interface.
+      
+      ```bash
+      # By default, only listens on localhost
+      lark-mcp recall-developer-documents -m sse -p 3000
+      
+      # Listen on all network interfaces (allow remote access)
+      lark-mcp recall-developer-documents -m sse --host 0.0.0.0 -p 3000
+      ```
+      
+      After starting, the SSE endpoint can be accessed at `http://<host>:<port>/sse`.
+
+## Related Links
+
+- [Feishu Open Platform](https://open.feishu.cn/)
+- [Lark International Open Platform](https://open.larksuite.com/)
+- [Node.js Official Website](https://nodejs.org/)
+- [npm Documentation](https://docs.npmjs.com/)
+
+## Feedback
+
+You are welcome to submit Issues to help improve this tool. If you have any questions or suggestions, please raise them in the GitHub repository.