Feishu/lark

🚀 Lark-mcp: A Tool for Feishu/Lark API Integration

Lark-mcp is a powerful tool designed to facilitate the integration of Feishu/Lark APIs. It offers API proxy services, multi - language support, and the ability to extend functionality through plugins. This guide will walk you through the installation, quick start, and usage scenarios of lark - mcp.

🚀 Quick Start

Installation

You can install lark - mcp using the following command:

npm install -g @larksuiteoapi/lark-mcp

If you need to specify a version, run:

npm install -g @larksuiteoapi/lark-mcp@x.x.x # Replace with the specific version number

Running the Command

After installation, you can start the MCP service with the following command:

lark-mcp --app-id=<your_app_id> --app-secret=<your_app_secret>

By default, the MCP service runs on the localhost:8092 port.

Environment Variable Configuration

For convenience, you can configure common parameters through environment variables:

# Configure the path to the configuration file
export LARK_MCP_CONFIG="./config.json"

# Set the application ID and secret
export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"

# Start the service
lark-mcp

Example Configuration File

{
  "app_id": "your_app_id",
  "app_secret": "your_app_secret",
  "port": 8092,
  "enableApis": ["im.v1.message.create", "im.v1.chat.create"]
}

✨ Features

Core Features

• API Proxy: Supports various API calls, from message creation to file management.
• Multi - language Support: Offers both Chinese and English interfaces to meet the needs of different users.
• Plugin Extension: Allows you to extend more functions through plugins.

Use Cases

• Development and Testing: Helps developers quickly integrate Feishu/Lark API features.
• Enterprise Applications: Used to build efficient enterprise - internal tools and services.
• Teaching Examples: Serves as an excellent learning and teaching resource.

📚 Documentation

FAQ

• Question: Unable to connect to the Feishu/Lark API.

  • Answer: Check your network connection and confirm that the APP_ID and APP_SECRET are correct. Ensure that you can access the Feishu/Lark Open Platform, and you may need to configure a proxy server.

• Question: An error occurs when using the user_access_token.

  • Answer: Check if the token has expired. Usually, the user_access_token is valid for 2 hours and needs to be refreshed regularly. You can implement an automatic refresh mechanism or use the app_access_token instead.

• Question: After starting the MCP service, you cannot call some APIs, and it prompts insufficient permissions.

  • Answer: Verify that the application has obtained the relevant API permissions. Some APIs require additional advanced permissions, which need to be configured and approved in the Open Platform console.

• Question: API calls related to uploading/downloading pictures or files fail.

  • Answer: The current version does not support the uploading/downloading of files and pictures. Future versions will gradually improve this functionality.

Related Links

• Feishu Open Platform
• Lark International Open Platform
• Feishu API Documentation
• Node.js Official Website
• npm Documentation

Feedback

You are welcome to provide feedback or report issues in the following ways:

• Email: support@larksuiteoapi.com
• GitHub Repository: Go to submit an Issue