MCP Server My Lark Doc

🚀 MCP 服务器我的飞书文档

这是一个用于搜索和访问飞书（Lark）文档的模型上下文协议服务器，可帮助用户方便地获取飞书文档内容，为LLM处理提供支持。

🚀 快速开始

在使用该服务器前，你需要完成安装和配置工作，具体步骤如下文所示。

✨ 主要特性

文档内容访问

• 支持飞书文档和Wiki两种文档类型，满足多样化的文档需求。
• 自动处理文档类型检测和ID提取，简化操作流程。
• 返回纯文本格式的内容供LLM处理，便于后续分析。

认证

• 基于OAuth的身份认证，保障用户信息安全。
• 自动刷新和管理令牌过期，无需手动干预。
• 可自定义的OAuth回调服务器，满足不同的使用场景。

错误处理

• 全面的认证问题错误报告，让你快速定位问题。
• 清晰的无效文档URL反馈，避免因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 进行许可。