Skip to main content

A Model Context Protocol server for accessing Lark documents

Project description

MCP Server Doc

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

Features

Document Content Access

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

Authentication

  • OAuth-based user authentication
  • Automatic token refresh and expiration management
  • Customizable OAuth callback server

Error Handling

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

Installation

uvx mcp-server-doc

Configuration

Get your Lark App ID and App Secret

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

Make Sure your Lark App has Permissions below

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

Environment Variables

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

  1. Create a Lark application in Lark Open Platform
  2. Get your App ID and App Secret
  3. Configure environment variables:
export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"

Usage

Configure in Claude desktop:

"mcpServers": {
    "lark_doc": {
        "command": "uvx",
        "args": ["mcp-server-doc"],
        "env": {
            "LARK_APP_ID": "your app id",
            "LARK_APP_SECRET": "your app secret",
        }
    }
}

Available Tools

  1. get_lark_doc_content

Error Messages

Common error messages and their solutions:

  • "Lark client not properly initialized": Check your LARK_APP_ID and LARK_APP_SECRET
  • "Invalid Lark document URL format": Verify the document URL format
  • "Failed to get document content": Check document permissions and token validity
  • "Failed to get app access token": Check your application credentials and network connection
  • "Failed to get wiki document real ID": Check if the wiki document exists and you have proper permissions
  • "Document content is empty": The document might be empty or you might not have access to its content
  • "Authorization timeout": ser didn't complete authorization within 5 minutes

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_lark_doc-0.0.1.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_lark_doc-0.0.1-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_lark_doc-0.0.1.tar.gz.

File metadata

  • Download URL: mcp_server_lark_doc-0.0.1.tar.gz
  • Upload date:
  • Size: 51.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for mcp_server_lark_doc-0.0.1.tar.gz
Algorithm Hash digest
SHA256 8171ac424b2204649bd7100cce64cc4fe250e2ce36edfba1edcb74b4a3b14302
MD5 0266930abeb9077afc2df4d8cb367bef
BLAKE2b-256 f8913f442f40e5b9fbc2ff69ec5396b7dcf659f41761dccd24f09bd45dd92369

See more details on using hashes here.

File details

Details for the file mcp_server_lark_doc-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_lark_doc-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4f390135e8092658cd4378a6f206604a88a302534f7555e8f39623c9b6d2c467
MD5 556b2b714f8e31bb3ff86c219b78879b
BLAKE2b-256 a3502db201efab320a8dddaf7b0b4d876423365d2385a1004a16adaffb0ce9ec

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page