feishu-mcp 0.0.9-alpha.2 → 0.0.10

package/dist/utils/logger.js

@@ -25,28 +25,13 @@ export class Logger {
     static configure(config) {
         this.config = { ...this.config, ...config };
         // 确保日志目录存在
-        if (this.config.logToFile && this.config.enabled) {
+        if (this.config.logToFile) {
             const logDir = path.dirname(this.config.logFilePath);
             if (!fs.existsSync(logDir)) {
                 fs.mkdirSync(logDir, { recursive: true });
             }
         }
     }
-    /**
-     * 设置日志开关
-     * @param enabled 是否启用日志
-     */
-    static setEnabled(enabled) {
-        this.config.enabled = enabled;
-    }
-    /**
-     * 检查日志是否可输出
-     * @param level 日志级别
-     * @returns 是否可输出
-     */
-    static canLog(level) {
-        return this.config.enabled && level >= this.config.minLevel;
-    }
     /**
      * 格式化日志消息
      * @param level 日志级别
@@ -74,7 +59,7 @@ export class Logger {
      * @param logParts 日志内容部分
      */
     static writeToFile(logParts) {
-        if (!this.config.enabled || !this.config.logToFile)
+        if (!this.config.logToFile)
             return;
         try {
             // 将日志内容转换为字符串
@@ -158,7 +143,7 @@ export class Logger {
      * @param args 日志参数
      */
     static debug(...args) {
-        if (this.canLog(LogLevel.DEBUG)) {
+        if (this.config.minLevel <= LogLevel.DEBUG) {
             const formattedMessage = this.formatLogMessage(LogLevel.DEBUG, args);
             console.debug(...formattedMessage);
             this.writeToFile(formattedMessage);
@@ -169,7 +154,7 @@ export class Logger {
      * @param args 日志参数
      */
     static info(...args) {
-        if (this.canLog(LogLevel.INFO)) {
+        if (this.config.minLevel <= LogLevel.INFO) {
             const formattedMessage = this.formatLogMessage(LogLevel.INFO, args);
             console.info(...formattedMessage);
             this.writeToFile(formattedMessage);
@@ -180,7 +165,7 @@ export class Logger {
      * @param args 日志参数
      */
     static log(...args) {
-        if (this.canLog(LogLevel.LOG)) {
+        if (this.config.minLevel <= LogLevel.LOG) {
             const formattedMessage = this.formatLogMessage(LogLevel.LOG, args);
             console.log(...formattedMessage);
             this.writeToFile(formattedMessage);
@@ -191,7 +176,7 @@ export class Logger {
      * @param args 日志参数
      */
     static warn(...args) {
-        if (this.canLog(LogLevel.WARN)) {
+        if (this.config.minLevel <= LogLevel.WARN) {
             const formattedMessage = this.formatLogMessage(LogLevel.WARN, args);
             console.warn(...formattedMessage);
             this.writeToFile(formattedMessage);
@@ -202,7 +187,7 @@ export class Logger {
      * @param args 日志参数
      */
     static error(...args) {
-        if (this.canLog(LogLevel.ERROR)) {
+        if (this.config.minLevel <= LogLevel.ERROR) {
             const formattedMessage = this.formatLogMessage(LogLevel.ERROR, args);
             console.error(...formattedMessage);
             this.writeToFile(formattedMessage);
@@ -217,7 +202,7 @@ export class Logger {
      * @param statusCode 响应状态码
      */
     static logApiCall(method, url, data, response, statusCode) {
-        if (this.canLog(LogLevel.DEBUG)) {
+        if (this.config.minLevel <= LogLevel.DEBUG) {
             this.debug('API调用详情:');
             this.debug(`请求: ${method} ${url}`);
             // 简化请求数据记录
@@ -250,7 +235,7 @@ export class Logger {
                 this.debug('响应数据: None');
             }
         }
-        else if (this.canLog(LogLevel.INFO)) {
+        else {
             this.info(`API调用: ${method} ${url} - 状态码: ${statusCode}`);
         }
     }
@@ -260,7 +245,6 @@ Object.defineProperty(Logger, "config", {
     configurable: true,
     writable: true,
     value: {
-        enabled: true, // 默认开启日志
         minLevel: LogLevel.DEBUG, // 修改为DEBUG级别，确保捕获所有日志
         showTimestamp: true,
         showLevel: true,

package/package.json

@@ -1,74 +1,74 @@
-{
-  "name": "feishu-mcp",
-  "version": "0.0.9-alpha.2",
-  "description": "Model Context Protocol server for Feishu integration",
-  "type": "module",
-  "main": "dist/index.js",
-  "bin": {
-    "feishu-mcp": "./dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "tsc && tsc-alias",
-    "type-check": "tsc --noEmit",
-    "start": "node dist/index.js",
-    "start:cli": "cross-env NODE_ENV=cli node dist/index.js",
-    "start:http": "node dist/index.js",
-    "dev": "cross-env NODE_ENV=development tsx watch src/index.ts",
-    "dev:cli": "cross-env NODE_ENV=development tsx watch src/index.ts --stdio",
-    "lint": "eslint . --ext .ts",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "inspect": "pnpx @modelcontextprotocol/inspector",
-    "prepare": "pnpm run build",
-    "pub:release": "pnpm build && npm publish"
-  },
-  "engines": {
-    "node": "^20.17.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/cso1z/Feishu-MCP.git"
-  },
-  "keywords": [
-    "feishu",
-    "lark",
-    "mcp",
-    "typescript"
-  ],
-  "author": "cso1z",
-  "license": "MIT",
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.6.1",
-    "@types/yargs": "^17.0.33",
-    "axios": "^1.7.9",
-    "cross-env": "^7.0.3",
-    "dotenv": "^16.4.7",
-    "express": "^4.21.2",
-    "remeda": "^2.20.1",
-    "yargs": "^17.7.2",
-    "zod": "^3.24.2"
-  },
-  "devDependencies": {
-    "@types/express": "^5.0.0",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.17.0",
-    "@typescript-eslint/eslint-plugin": "^8.24.0",
-    "@typescript-eslint/parser": "^8.24.0",
-    "eslint": "^9.20.1",
-    "eslint-config-prettier": "^10.0.1",
-    "jest": "^29.7.0",
-    "prettier": "^3.5.0",
-    "ts-jest": "^29.2.5",
-    "tsc-alias": "^1.8.10",
-    "tsx": "^4.19.2",
-    "typescript": "^5.7.3"
-  },
-  "pnpm": {
-    "overrides": {
-      "feishu-mcp": "link:"
-    }
-  }
-}
+{
+  "name": "feishu-mcp",
+  "version": "0.0.10",
+  "description": "Model Context Protocol server for Feishu integration",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "feishu-mcp": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "type-check": "tsc --noEmit",
+    "start": "node dist/index.js",
+    "start:cli": "cross-env NODE_ENV=cli node dist/index.js",
+    "start:http": "node dist/index.js",
+    "dev": "cross-env NODE_ENV=development tsx watch src/index.ts",
+    "dev:cli": "cross-env NODE_ENV=development tsx watch src/index.ts --stdio",
+    "lint": "eslint . --ext .ts",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "inspect": "pnpx @modelcontextprotocol/inspector",
+    "prepare": "pnpm run build",
+    "pub:release": "pnpm build && npm publish"
+  },
+  "engines": {
+    "node": "^20.17.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cso1z/Feishu-MCP.git"
+  },
+  "keywords": [
+    "feishu",
+    "lark",
+    "mcp",
+    "typescript"
+  ],
+  "author": "cso1z",
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.1",
+    "@types/yargs": "^17.0.33",
+    "axios": "^1.7.9",
+    "cross-env": "^7.0.3",
+    "dotenv": "^16.4.7",
+    "express": "^4.21.2",
+    "remeda": "^2.20.1",
+    "yargs": "^17.7.2",
+    "zod": "^3.24.2"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.17.0",
+    "@typescript-eslint/eslint-plugin": "^8.24.0",
+    "@typescript-eslint/parser": "^8.24.0",
+    "eslint": "^9.20.1",
+    "eslint-config-prettier": "^10.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.0",
+    "ts-jest": "^29.2.5",
+    "tsc-alias": "^1.8.10",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.3"
+  },
+  "pnpm": {
+    "overrides": {
+      "feishu-mcp": "link:"
+    }
+  }
+}

package/README.en.md

@@ -1,201 +0,0 @@
-# Feishu MCP Server
-
-Provides access to Feishu (Lark) documents for [Cursor](https://cursor.sh/), [Windsurf](https://codeium.com/windsurf), [Cline](https://cline.bot/), and other AI-driven coding tools, implemented based on the [Model Context Protocol](https://modelcontextprotocol.io/introduction) server.
-
-When Cursor can access Feishu document data, it can understand and process document content more accurately, making it more efficient than other methods (such as copying and pasting text).
-
-## Core Features
-
-### Document Management
-- **Create Feishu Documents**: Support for creating new Feishu documents in specified folders
-- **Folder Management**:
-  - Get root folder information
-  - View folder contents and file lists
-  - Create new folders
-
-### Document Content Operations
-- **Get Document Information**:
-  - Get basic document information (title, version, etc.)
-  - Get document block structure and hierarchy
-  - Get detailed content of specific blocks
-- **Get Document Plain Text Content**: Support for extracting complete plain text content from documents for analysis and processing
-- **Edit Document Content**:
-  - **Text Block Operations**:
-    - Create and update text blocks with rich styles (bold, italic, underline, strikethrough, inline code)
-    - Support for text color settings (gray, brown, orange, yellow, green, blue, purple)
-    - Support for text alignment adjustment (left-aligned, centered, right-aligned)
-  - **Heading Block Operations**: Create headings from level one to level nine
-  - **Code Block Operations**:
-    - Create code blocks for multiple programming languages
-    - Support for code syntax highlighting
-    - Support for automatic line wrapping settings
-  - **List Operations**:
-    - Create ordered lists (numbered lists)
-    - Create unordered lists (bullet point lists)
-  - **Block Management Operations**:
-    - Batch content creation: Support for creating multiple different types of content blocks in a single operation
-    - Delete document blocks: Support for deleting one or more consecutive document blocks
-- **Wiki Document Support**:
-  - Convert Feishu Wiki links to compatible document IDs for use with other document operation tools
-- **Image Resource Processing**:
-  - Download images from Feishu using media IDs
-
-### Planned Features
-- **Advanced Content Insertion**:
-  - Table insertion: Support for row and column structured data
-  - Insert charts: Support for various data visualization charts
-  - Insert flowcharts: Support for flowcharts and mind maps
-  - Insert formulas: Support for mathematical formulas and scientific symbols
-- Recognition and parsing of charts and flowcharts
-
-Quick start, see the [Configuration](#configuration) section for details:
-
-```bash
-npx feishu-mcp --feishu-app-id=<YOUR_FEISHU_APP_ID> --feishu-app-secret=<YOUR_FEISHU_APP_SECRET>
-```
-
-## How It Works
-
-1. Open the editor in Cursor's Agent mode.
-2. Paste a Feishu document link.
-3. Ask Cursor to perform operations based on the Feishu document—for example, analyze document content or create related code.
-4. Cursor will retrieve relevant metadata from Feishu and use it to assist in writing code.
-
-This MCP server is designed specifically for Cursor. Before responding with content from the [Feishu API](https://open.feishu.cn/document/home/introduction-to-lark-open-platform/overview), it simplifies and transforms the responses, ensuring that only the most relevant document information is provided to the model.
-
-## Installation
-
-### Quickly Run the Server Using NPM
-
-You can quickly run the server using NPM without installing or building the repository:
-
-```bash
-npx feishu-mcp --feishu-app-id=<YOUR_FEISHU_APP_ID> --feishu-app-secret=<YOUR_FEISHU_APP_SECRET>
-
-# or
-pnpx feishu-mcp --feishu-app-id=<YOUR_FEISHU_APP_ID> --feishu-app-secret=<YOUR_FEISHU_APP_SECRET>
-
-# or
-yarn dlx feishu-mcp --feishu-app-id=<YOUR_FEISHU_APP_ID> --feishu-app-secret=<YOUR_FEISHU_APP_SECRET>
-
-# or
-bunx feishu-mcp --feishu-app-id=<YOUR_FEISHU_APP_ID> --feishu-app-secret=<YOUR_FEISHU_APP_SECRET>
-```
-
-**Published to the Smithery platform, available at: https://smithery.ai/server/@cso1z/feishu-mcp**
-
-Instructions on how to create a Feishu application and obtain application credentials can be found in the [official tutorial](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app).
-
-**Detailed Feishu application configuration steps**: For detailed guidance on registering a Feishu application, configuring permissions, and adding document access permissions, please refer to [Step-by-step tutorial FEISHU_CONFIG.md](FEISHU_CONFIG.md).
-
-### JSON Configuration for Tools Using Configuration Files
-
-Many tools such as Windsurf, Cline, and [Claude Desktop](https://claude.ai/download) use configuration files to start servers.
-
-The `feishu-mcp` server can be configured by adding the following to the configuration file:
-
-```json
-{
-  "mcpServers": {
-    "feishu-mcp": {
-      "command": "npx",
-      "args": ["-y", "feishu-mcp", "--stdio"],
-      "env": {
-        "FEISHU_APP_ID": "<YOUR_FEISHU_APP_ID>",
-        "FEISHU_APP_SECRET": "<YOUR_FEISHU_APP_SECRET>"
-      }
-    }
-  }
-}
-```
-
-### Run the Server from Local Source Code
-
-1. Clone the repository
-2. Install dependencies using `pnpm install`
-3. Copy `.env.example` to `.env` and fill in your [Feishu application credentials](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app).
-4. Run the server using `pnpm run dev`, with any flags from the [Command Line Arguments](#command-line-arguments) section.
-
-### Run the Server Using Docker
-
-You can use Docker to run the server, which avoids installing Node.js and other dependencies locally:
-
-1. Build the Docker image:
-```bash
-docker build -t feishu-mcp .
-```
-
-2. Run the Docker container:
-```bash
-docker run -p 3333:3333 --env FEISHU_APP_ID=<YOUR_FEISHU_APP_ID> --env FEISHU_APP_SECRET=<YOUR_FEISHU_APP_SECRET> feishu-mcp
-```
-
-Alternatively, you can use docker-compose:
-
-1. Edit the `.env` file and add your Feishu application credentials:
-```
-FEISHU_APP_ID=<YOUR_FEISHU_APP_ID>
-FEISHU_APP_SECRET=<YOUR_FEISHU_APP_SECRET>
-```
-
-2. Run docker-compose:
-```bash
-docker-compose up -d
-```
-
-This will start the server in the background and expose it on port 3333.
-
-## Configuration
-
-The server can be configured using environment variables (via the `.env` file) or command line arguments. Command line arguments take precedence over environment variables.
-
-### Environment Variables
-
-- `FEISHU_APP_ID`: Your [Feishu application ID](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) (required)
-- `FEISHU_APP_SECRET`: Your [Feishu application secret](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) (required)
-- `PORT`: The port to run the server on (default: 3333)
-
-### Command Line Arguments
-
-- `--version`: Show version number
-- `--feishu-app-id`: Your Feishu application ID
-- `--feishu-app-secret`: Your Feishu application secret
-- `--port`: The port to run the server on
-- `--stdio`: Run the server in command mode instead of the default HTTP/SSE
-- `--help`: Show help menu
-
-## Connecting to Cursor
-
-### Configuring Cursor
-
-1. Open Cursor settings
-2. Navigate to `Settings > AI > MCP Servers`
-3. Add a new server with the URL `http://localhost:3333` (or your configured port)
-4. Click "Verify Connection" to ensure the connection is successful
-
-## Usage
-
-1. In Cursor, open the AI panel (default shortcut `Cmd+K` or `Ctrl+K`)
-2. If you need to create a new Feishu document, you should explicitly specify a folderToken, which you can find by opening a Feishu document directory like: `https://vq5xxxxx7bc.feishu.cn/drive/folder/FPKvfjdxxxxx706RnOc`
-3. If you need to modify Feishu document content, you should explicitly provide the Feishu document link, for example: `https://vq5ixxxx7bc.feishu.cn/docx/J6T0d6exxxxxxxDdc1zqwnph`
-4. Ask questions about the document or request operations based on the document content
-5. Creating and editing documents requires permissions, and you can test your account on the Feishu open platform: `https://open.feishu.cn/api-explorer/cli_a75a8ca0ac79100c?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3`
-
-## Document Permissions and Troubleshooting
-
-### Permission Types
-Permissions are divided into two types: robot permissions and document access permissions.
-
-### Permission Verification and Troubleshooting
-1. Get token: [https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=tenant_access_token_internal&project=auth&resource=auth&version=v3](https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=tenant_access_token_internal&project=auth&resource=auth&version=v3)
-2. Using the token obtained in step 1, verify whether you have permission to access the document: [https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=get&project=docx&resource=document&version=v1](https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=get&project=docx&resource=document&version=v1)
-
-### Troubleshooting Method
-Test permissions normally on the Feishu development platform (when debugging on the open platform, there will be sufficient prompt information and guidance in case of failure).
-
-### Document Authorization
-If you encounter permission issues, please refer to [Cloud Document FAQ](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN), [Knowledge Base FAQ](https://open.feishu.cn/document/server-docs/docs/wiki-v2/wiki-qa), especially focusing on how to grant document permissions to applications or users.
-
-## License
-
-MIT 

package/dist/manager/sseConnectionManager.js

@@ -1,104 +0,0 @@
-import { Logger } from '../utils/logger.js';
-/**
- * SSE连接管理器 - 负责管理所有的SSE长连接和心跳机制
- */
-export class SSEConnectionManager {
-    constructor() {
-        Object.defineProperty(this, "transports", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        Object.defineProperty(this, "connections", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-        Object.defineProperty(this, "keepAliveIntervalId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: null
-        });
-        Object.defineProperty(this, "KEEP_ALIVE_INTERVAL_MS", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 1000 * 25
-        }); // 25秒心跳间隔
-        this.startGlobalKeepAlive();
-    }
-    /**
-     * 启动全局心跳管理
-     */
-    startGlobalKeepAlive() {
-        if (this.keepAliveIntervalId) {
-            clearInterval(this.keepAliveIntervalId);
-        }
-        this.keepAliveIntervalId = setInterval(() => {
-            Logger.info(`[KeepAlive] Sending keepalive to ${this.connections.size} connections`);
-            for (const [sessionId, connection] of this.connections.entries()) {
-                if (!connection.res.writableEnded) {
-                    connection.res.write(': keepalive\n\n');
-                }
-                else {
-                    // 移除已关闭的连接
-                    this.removeConnection(sessionId);
-                }
-            }
-        }, this.KEEP_ALIVE_INTERVAL_MS);
-    }
-    /**
-     * 添加新的SSE连接
-     */
-    addConnection(sessionId, transport, req, res) {
-        this.transports[sessionId] = transport;
-        this.connections.set(sessionId, { res });
-        console.info(`[SSE Connection] Client connected: ${sessionId}`);
-        req.on('close', () => {
-            this.removeConnection(sessionId);
-        });
-    }
-    /**
-     * 移除SSE连接
-     */
-    removeConnection(sessionId) {
-        const transport = this.transports[sessionId];
-        if (transport) {
-            try {
-                transport.close();
-                Logger.info(`[SSE Connection] Transport closed for: ${sessionId}`);
-            }
-            catch (error) {
-                Logger.error(`[SSE Connection] Error closing transport for: ${sessionId}`, error);
-            }
-        }
-        delete this.transports[sessionId];
-        this.connections.delete(sessionId);
-        console.info(`[SSE Connection] Client disconnected: ${sessionId}`);
-    }
-    /**
-     * 获取指定sessionId的传输实例
-     */
-    getTransport(sessionId) {
-        console.info(`[SSE Connection] Getting transport for sessionId: ${sessionId}`);
-        return this.transports[sessionId];
-    }
-    /**
-     * 关闭连接管理器
-     */
-    shutdown() {
-        if (this.keepAliveIntervalId) {
-            clearInterval(this.keepAliveIntervalId);
-            this.keepAliveIntervalId = null;
-        }
-        // 关闭所有连接
-        Logger.info(`[SSE Connection] Shutting down all connections (${this.connections.size} active)`);
-        for (const sessionId of this.connections.keys()) {
-            this.removeConnection(sessionId);
-        }
-        Logger.info(`[SSE Connection] All connections closed`);
-    }
-}

package/dist/mcp/feishuMcp.js

@@ -1,67 +0,0 @@
-import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { FeishuApiService } from '../services/feishuApiService.js';
-import { Logger } from '../utils/logger.js';
-import { registerFeishuTools } from './tools/feishuTools.js';
-import { registerFeishuBlockTools } from './tools/feishuBlockTools.js';
-import { registerFeishuFolderTools } from './tools/feishuFolderTools.js';
-const serverInfo = {
-    name: "Feishu MCP Server",
-    version: "0.0.9-alpha",
-};
-const serverOptions = {
-    capabilities: { logging: {}, tools: {} },
-};
-/**
- * 飞书MCP服务类
- * 继承自McpServer，提供飞书工具注册和初始化功能
- */
-export class FeishuMcp extends McpServer {
-    /**
-     * 构造函数
-     */
-    constructor() {
-        super(serverInfo, serverOptions);
-        Object.defineProperty(this, "feishuService", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: null
-        });
-        // 初始化飞书服务
-        this.initFeishuService();
-        // 注册所有工具
-        if (this.feishuService) {
-            this.registerAllTools();
-        }
-        else {
-            Logger.error('无法注册飞书工具: 飞书服务初始化失败');
-            throw new Error('飞书服务初始化失败');
-        }
-    }
-    /**
-     * 初始化飞书API服务
-     */
-    initFeishuService() {
-        try {
-            // 使用单例模式获取飞书服务实例
-            this.feishuService = FeishuApiService.getInstance();
-            Logger.info('飞书服务初始化成功');
-        }
-        catch (error) {
-            Logger.error('飞书服务初始化失败:', error);
-            this.feishuService = null;
-        }
-    }
-    /**
-     * 注册所有飞书MCP工具
-     */
-    registerAllTools() {
-        if (!this.feishuService) {
-            return;
-        }
-        // 注册所有工具
-        registerFeishuTools(this, this.feishuService);
-        registerFeishuBlockTools(this, this.feishuService);
-        registerFeishuFolderTools(this, this.feishuService);
-    }
-}