MCP Server My Lark Doc

🚀 MCP 服務器我的飛書文檔

這是一個用於搜索和訪問飛書（Lark）文檔的模型上下文協議服務器，能幫助用戶便捷地獲取飛書文檔內容，支持多種文檔類型，具備完善的認證和錯誤處理機制。

🚀 快速開始

本服務器可用於搜索和訪問飛書文檔，以下是使用前的準備和使用步驟。

✨ 主要特性

文檔內容訪問

• 支持飛書文檔和Wiki兩種文檔類型，滿足不同場景需求。
• 自動處理文檔類型檢測和ID提取，無需手動干預。
• 返回純文本格式的內容，方便LLM進行處理。

認證

• 基於OAuth的身份認證，保障訪問安全。
• 自動刷新和管理令牌過期，無需人工維護。
• 可自定義的OAuth回調服務器，靈活配置。

錯誤處理

• 全面的認證問題錯誤報告，快速定位問題。
• 清晰的無效文檔URL反饋，方便排查。
• 詳細的錯誤信息用於故障排除，提高解決問題效率。

📦 安裝指南

使用以下命令進行安裝：

uvx mcp-server-my-lark-doc

📚 詳細文檔

獲取你的飛書應用ID和應用密鑰

訪問飛書開放平臺: https://open.larkoffice.com/app

確保你的飛書應用具備以下權限

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

環境變量配置

在使用此MCP服務器之前，需要設置飛書應用程序憑證：

1. 在飛書開放平臺創建一個飛書應用。
2. 獲取你的App ID和App Secret。
3. 配置環境變量：

export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"
export OAUTH_HOST="localhost"               # OAuth回調服務器主機（默認：localhost）
export OAUTH_PORT="9997"                   # OAuth回調服務器端口（默認：9997）

💻 使用示例

基礎用法

在Claude桌面中進行配置：

"mcpServers": {
    "lark_doc": {
        "command": "uvx",
        "args": ["mcp-server-my-lark-doc"],
        "env": {
            "LARK_APP_ID": "你的應用ID",
            "LARK_APP_SECRET": "你的應用密鑰",
            "OAUTH_HOST": "localhost",   // 可選   
            "OAUTH_PORT": "9997"        // 可選  
        }
    }
}

已提供的工具

get_lark_doc_content

• 目的：從飛書獲取文檔內容
• 參數：documentUrl (字符串) - 飛書文檔的URL
• 返回：文本格式的文檔內容
• 支持:
  • Doc URL: https://xxx.feishu.cn/docx/xxxxx
  • Wiki URL: https://xxx.feishu.cn/wiki/xxxxx

search_wiki

• 目的：在飛書Wiki中搜索文檔
• 參數:
  • query (字符串) - 搜索關鍵詞
  • page_size (整數，可選) - 返回結果的數量（默認：10）
• 返回: 包含搜索結果的JSON字符串，包含以下字段:
  • title: 文檔標題
  • url: 文檔URL
  • create_time: 文檔創建時間
  • update_time: 文檔最後更新時間

🔧 技術細節

錯誤信息

常見錯誤消息及解決方案：

• "飛書客戶端未正確初始化": 檢查你的LARK_APP_ID和LARK_APP_SECRET。
• "無效的飛書文檔URL格式": 驗證文檔URL格式。
• "獲取文檔內容失敗": 檢查文檔權限和令牌的有效性。
• "獲取應用訪問令牌失敗": 檢查應用程序憑證和網絡連接。
• "獲取Wiki文檔真實ID失敗": 檢查Wiki文檔是否存在且具有適當的權限。
• "文檔內容為空": 文檔可能為空或你沒有訪問其內容的權限。
• "授權超時": 服務器在5分鐘內未完成授權。

開發注意事項

OAuth 回調服務器

默認配置:

• 主機: localhost
• 端口: 9997 通過環境變量自定義:
• OAUTH_HOST: 設置回調服務器主機
• OAUTH_PORT: 設置回調服務器端口

📄 許可證

MIT License