MCP Server My Lark Doc

🚀 MCP Server for My Lark Documents

A model context protocol server for searching and accessing Lark documents.

🚀 Quick Start

The MCP Server for My Lark Documents is a powerful tool designed to search and access Lark documents. It offers seamless integration with Lark, providing various functions such as document content access, authentication, and error handling.

✨ Features

Document Content Access

• Supports two types of documents: Lark documents and Wikis.
• Automatically handles document type detection and ID extraction.
• Returns content in plain text format for LLM processing.

Authentication

• OAuth-based identity authentication.
• Automatically refreshes and manages token expiration.
• Customizable OAuth callback server.

Error Handling

• Comprehensive error reporting for authentication issues.
• Clear feedback for invalid document URLs.
• Detailed error information for troubleshooting.

📦 Installation

uvx mcp-server-my-lark-doc

📚 Documentation

Obtain Your Lark App ID and App Secret

Visit the Lark Open Platform: https://open.larkoffice.com/app

Ensure Your Lark App Has the Following Permissions

wiki:wiki:readonly
wiki:node:read
docx:document:readonly
search:docs:read

Environment Variable Configuration

Before using this MCP server, you need to set the Lark application credentials:

1. Create a Lark app on the Lark Open Platform.
2. Obtain your App ID and App Secret.
3. Configure the environment variables:

export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"
export OAUTH_HOST="localhost"               # OAuth callback server host (default: localhost)
export OAUTH_PORT="9997"                   # OAuth callback server port (default: 9997)

💻 Usage Examples

Basic Usage

Configure in Claude Desktop:

"mcpServers": {
    "lark_doc": {
        "command": "uvx",
        "args": ["mcp-server-my-lark-doc"],
        "env": {
            "LARK_APP_ID": "your_app_id",
            "LARK_APP_SECRET": "your_app_secret",
            "OAUTH_HOST": "localhost",   // Optional   
            "OAUTH_PORT": "9997"        // Optional  
        }
    }
}

Advanced Usage

Provided Tools

1. get_lark_doc_content

   • Purpose: Retrieve document content from Lark.
   • Parameters: documentUrl (string) - The URL of the Lark document.
   • Returns: Document content in text format.
   • Supported:
     • Doc URL: https://xxx.feishu.cn/docx/xxxxx
     • Wiki URL: https://xxx.feishu.cn/wiki/xxxxx

2. search_wiki

   • Purpose: Search for documents in the Lark Wiki.
   • Parameters:
     • query (string) - Search keywords.
     • page_size (integer, optional) - Number of returned results (default: 10).
   • Returns: A JSON string containing search results with the following fields:
     • title: Document title.
     • url: Document URL.
     • create_time: Document creation time.
     • update_time: Document last update time.

🔧 Technical Details

Error Messages

Common error messages and solutions:

• "Lark client is not initialized correctly": Check your LARK_APP_ID and LARK_APP_SECRET.
• "Invalid Lark document URL format": Verify the document URL format.
• "Failed to retrieve document content": Check document permissions and token validity.
• "Failed to obtain the application access token": Check application credentials and network connection.
• "Failed to obtain the real ID of the Wiki document": Check if the Wiki document exists and has appropriate permissions.
• "Document content is empty": The document may be empty or you do not have permission to access its content.
• "Authorization timed out": The server did not complete authorization within 5 minutes.

OAuth Callback Server

Default configuration:

• Host: localhost
• Port: 9997 Customize via environment variables:
• OAUTH_HOST: Set the callback server host.
• OAUTH_PORT: Set the callback server port.

📄 License

MIT License