Lark_doc

笔记官方认证 Python

🚀 Lark 文档管理 MCP 服务器

这是一个用于搜索和访问 Lark（飞书）文档的 Model Context Protocol 服务器，能帮助用户便捷地处理飞书文档，为 LLM 提供纯文本格式的文档内容。

中文文档

⚠️ 重要提示

在使用此 MCP 服务器之前，您需要有一个 Lark 企业应用。如果您还没有创建，请按照下面的设置说明进行操作。

✨ 主要特性

文档内容访问

支持 Lark Doc 和 Wiki 文档类型。
自动处理文档类型检测和 ID 提取。
返回纯文本格式的内容供 LLM 处理。

认证

基于 OAuth 的用户认证。
自动刷新令牌和过期管理。
可自定义的 OAuth 回调服务器。

错误处理

全面的身份验证问题报告。
清晰的无效文档 URL 反馈。
详细的错误消息用于故障排除。

📦 安装指南

uvx mcp-lark-doc-manage

📚 详细文档

创建您的 Lark 企业应用

访问 Lark 开放平台。
点击右上角的“开发者控制台”。
点击“创建自建应用”。
填写基本信息：
- 应用名称
- 应用描述
- 应用图标
在“安全设置”部分：
- 将您的域名添加到“请求域名白名单”。
- 配置 OAuth 2.0 设置。
启用所需的 capability 和在“权限管理”中申请权限。
提交审核并等待批准。

有关详细说明，请参阅自建应用开发流程。

获取 App ID 和 App Secret

获取 App ID：
- 转到您在开发者控制台中的应用。
- 点击应用卡片中的“查看应用查看详情”。
- 在“应用概览”页面中，找到并复制“App ID”。
获取 App Secret：
- 在同一个应用的“设置”菜单下，选择“开发者信息”。
- 找到“生成密钥”按钮并点击。
- 在弹出窗口中，点击“生成”以获取 App Secret。

配置回调地址（可选）

如果需要配置回调地址，请在应用的“设置”菜单下，选择“授权回调地址”，添加您的回调 URL。

环境变量配置

您可以在 config.json 文件中设置以下环境变量：

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

获取 Folder Token

要获取文件夹令牌，请按照以下步骤操作：

登录 Lark 并导航到您需要获取令牌的文件夹。
复制文件夹 URL 地址。
在 MCP 服务器中，设置环境变量 FOLDER_TOKEN 为该 URL 地址。

💻 使用示例

基础用法

列出文档

# 列出指定文件夹中的文档
curl -X GET "http://localhost:8080/api/list Documents?pageSize=10"

# 列出所有文档（不带路径）
curl -X GET "http://localhost:8080/api/list"

搜索 Wiki 文档

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

创建新文档

curl -X POST "http://localhost:8080/api/createDoc" \
-H "Content-Type: application/json" \
-d '{"title":"新建文档","content":"# 新建文档\n欢迎使用 MCP 服务器！"}'

🔧 错误处理

获取文档内容失败

错误信息：Failed to get document content
解决方法：
1. 检查文档权限。
2. 确保令牌有效。
3. 如果问题持续，联系 Lark 支持团队。

🔧 技术细节

OAuth 回调服务器

默认配置：

主机：localhost
端口：9997

通过环境变量自定义：

OAUTH_HOST：设置回调服务器主机
OAUTH_PORT：设置回调服务器端口

📄 许可证

MIT License

0 条评论
分类：笔记