Lark Doc

🚀 Lark Document Management MCP Server

A Model Context Protocol server for searching and accessing Lark documents.

Chinese Documentation

⚠️ Important Note

Before using this MCP server, you need to have a Lark enterprise application. If you haven't created one yet, please follow the setup instructions below.

✨ Features

Document Content Access

• Supports Lark Doc and Wiki document types.
• Automatically handles document type detection and ID extraction.
• Returns content in plain text format for LLM processing.

Authentication

• User authentication based on OAuth.
• Automatically refreshes tokens and manages expiration.
• Customizable OAuth callback server.

Error Handling

• Comprehensive reporting of authentication issues.
• Clear feedback on invalid document URLs.
• Detailed error messages for troubleshooting.

📦 Installation

uvx mcp-lark-doc-manage

📚 Documentation

Create Your Lark Enterprise Application

1. Visit the Lark Open Platform.
2. Click "Developer Console" in the top right corner.
3. Click "Create a self-built application".
4. Fill in the basic information:
   • Application name
   • Application description
   • Application icon
5. In the "Security settings" section:
   • Add your domain to the "Request domain whitelist".
   • Configure OAuth 2.0 settings.
6. Enable the required capabilities and apply for permissions in "Permission management".
7. Submit for review and wait for approval.

For detailed instructions, please refer to the Self-built application development process.

Obtain the App ID and App Secret

1. Obtain the App ID:

   • Go to your application in the Developer Console.
   • Click "View application details" on the application card.
   • On the "Application overview" page, find and copy the "App ID".

2. Obtain the App Secret:

   • Under the "Settings" menu of the same application, select "Developer information".
   • Find the "Generate key" button and click it.
   • In the pop-up window, click "Generate" to obtain the App Secret.

Configure the Callback Address (Optional)

If you need to configure the callback address, under the "Settings" menu of the application, select "Authorization callback address" and add your callback URL.

Environment Variable Configuration

You can set the following environment variables in the config.json file:

{
  "LARK_APP_ID": "your_app_id",
  "LARK_APP_SECRET": "your_app_secret",
  "LARK_CALLBACK_DOMAIN": "your_callback_domain"
}

Obtain the Folder Token

To obtain the folder token, follow these steps:

1. Log in to Lark and navigate to the folder for which you need to obtain the token.
2. Copy the folder URL address.
3. In the MCP server, set the environment variable FOLDER_TOKEN to this URL address.

💻 Usage Examples

List Documents

# List documents in a specified folder
curl -X GET "http://localhost:8080/api/list Documents?pageSize=10"

# List all documents (without paths)
curl -X GET "http://localhost:8080/api/list"

Search Wiki Documents

curl -X GET "http://localhost:8080/api/searchWiki?query=test&pageSize=5"

Create a New Document

curl -X POST "http://localhost:8080/api/createDoc" \
     -H "Content-Type: application/json" \
     -d '{"title":"New Document","content":"# New Document\nWelcome to use the MCP server!"}'

Error Handling

Failed to Get Document Content

• Error message: Failed to get document content
• Solution:
  1. Check document permissions.
  2. Ensure the token is valid.
  3. If the problem persists, contact the Lark support team.

Development Notes

OAuth Callback Server

Default configuration:

• Host: localhost
• Port: 9997

Customize through environment variables:

• OAUTH_HOST: Set the callback server host.
• OAUTH_PORT: Set the callback server port.

📄 License

MIT License