feishu-mcp 0.0.9 → 0.0.11

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