Feishu (Lark)

🚀 Usage Guide

This guide provides a comprehensive overview of how to install, configure, and use the application, as well as how to troubleshoot potential issues.

🚀 Quick Start

📦 Installation

1. Clone the repository.
2. Run pnpm install to install dependencies.
3. Copy .env.example to .env and fill in the Feishu application credentials.
4. Start the server using pnpm run dev, and you can use command-line parameters.

⚙️ Configuration Guide

Environment Variable Configuration

• FEISHU_APP_ID: Feishu application ID (required).
• FEISHU_APP_SECRET: Feishu application secret key (required).
• PORT: The port on which the server runs, defaulting to 3333.

Command-Line Parameters

• --version: Display the version number.
• --feishu-app-id: Specify the Feishu application ID.
• --feishu-app-secret: Specify the Feishu application secret key.
• --port: Specify the server port.
• --stdio: Run the server in command-line mode.
• --help: Display help information.

🔗 Connection Configuration

1. Open Cursor settings.
2. Navigate to Settings > AI > MCP Servers.
3. Add a new server and set the URL to http://localhost:3333 (or a custom port).
4. Click "Verify Connection" to check the connection status.

💻 Usage Examples

Basic Usage

1. Open the AI panel in Cursor (default shortcut: Cmd+K or Ctrl+K).
2. When creating a new Feishu document, specify the folderToken. For example, access the folder link like: https://vq5xxxxx7bc.feishu.cn/drive/folder/FPKvfjdxxxxx706RnOc查找.
3. When modifying document content, provide the specific document link. For example: https://vq5ixxxx7bc.feishu.cn/docx/J6T0d6exxxxxxxDdc1zqwnph.
4. Ask questions or request operations based on the document content.

🔒 Permission Configuration and Troubleshooting

Permission Types

• Bot permissions
• Document access permissions

Permission Verification and Troubleshooting

1. Obtain a token: https://open.feishu.cn/api-explorer/cli_a75a8ca0ac79100c?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3.
2. Use the token to verify document access permissions: https://open.feishu.cn/api-explorer/cli_a7582508c93ad16b?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3.

Important Note

• Ensure that the application has sufficient permissions.
• Make sure the document link is correct.
• Check the console output logs.

📚 Additional Information

• Supported command-line tools: pnpm, npm.
• Configuration example: Content of the .env file.
• Debugging guide: How to troubleshoot issues.