为 Cursor、Windsurf 和 Cline 提供基于 Model Context Protocol 的服务器实现,以访问、编辑和结构化飞书文档。
该项目使AI编码工具能够直接访问并理解飞书文档中的结构化内容,显著提高文档处理的智能性和效率。
全面覆盖飞书文档的实际使用过程,帮助您高效利用文档资源:
该项目让您在日常使用飞书文档的过程中实现智能检索、编辑和搜索,提高内容处理效率和体验。
您可以通过以下视频了解MCP的实际使用效果和操作流程:
<a href="https://www.bilibili.com/video/BV1z7MdzoEfu/?vd_source=94c14da5a71aeb01f665f159dd3d89c8"> <img src="image/demo.png" alt="飞书 MCP 使用演示" width="300"/> </a> <a href="https://www.bilibili.com/video/BV18z3gzdE1w/?vd_source=94c14da5a71aeb01f665f159dd3d89c8"> <img src="image/demo_1.png" alt="飞书 MCP 使用演示" width="300"/> </a>⭐ 给项目点赞,第一时间获得最新特性和重要更新! 关注项目可以帮助您不遗漏任何新特性、修复和优化,帮助您持续高效地使用。您的支持也将帮助我们更好地改进和发展项目。⭐
| 功能类别 | 工具名称 | 描述 | 使用场景 | 状态 |
|---|---|---|---|---|
| 文档管理 | create_feishu_document | 创建新的飞书文档 | 从零开始创建文档 | ✅ 完成 |
get_feishu_document_info | 获取文档的基本信息 | 验证文档的存在和权限 | ✅ 完成 | |
get_feishu_document_blocks | 获取文档块结构 | 理解文档层次结构 | ✅ 完成 | |
| 内容编辑 | batch_create_feishu_blocks | 批量创建多个块 | 高效创建连续内容 | ✅ 完成 |
update_feishu_block_text | 更新块文本内容 | 修改现有内容 | ✅ 完成 | |
delete_feishu_document_blocks | 删除文档块 | 清理和重构文档内容 | ✅ 完成 | |
| 文件夹管理 | get_feishu_folder_files | 获取文件夹文件列表 | 浏览文件夹内容 | ✅ 完成 |
create_feishu_folder | 创建新的文件夹 | 组织文档结构 | ✅ 完成 | |
| 搜索功能 | search_feishu_documents | 搜索文档 | 查找特定内容 | ✅ 完成 |
| 工具功能 | convert_feishu_wiki_to_document_id | 维基链接转换 | 将维基链接转换为文档ID | ✅ 完成 |
get_feishu_image_resource | 获取图像资源 | 从文档下载图像 | ✅ 完成 | |
get_feishu_whiteboard_content | 获取绘图板内容 | 获取绘图板中的图形元素和结构(流程图、思维导图等) | ✅ 完成 | |
| 高级功能 | create_feishu_table | 创建和编辑表格 | 结构化数据展示 | ✅ 完成 |
| 过程图插入 | 支持流程图和思维导图 | 过程组织和可视化 | ✅ 完成 | |
| 图像插入 | upload_and_bind_image_to_block | 支持插入本地和远程图像 | 修改文档内容 | ✅ 完成 |
| 公式支持 | 支持数学公式 | 学术和技术文档 | ✅ 完成 |
⚠️ 重要提醒:在开始使用前,需要完成飞书应用配置,否则此工具无法正常使用。
关于如何创建飞书应用并获取应用凭证,请参见官方教程。
详细的飞书应用配置步骤对于注册飞书应用、配置权限以及添加文档访问权限的详细指南,请参考 手把手教程 FEISHUVNet.md。
npx feishu-mcp@latest --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥> --feishu-auth-type=<tenant/user>
克隆仓库
git clone https://github.com/cso1z/Feishu-MCP.git
cd Feishu-MCP
安装依赖
pnpm install
配置环境变量(复制.env.example文件并保存为.env文件)
编辑.env文件
在项目的根目录中使用任何文本编辑器打开.env文件,填写您的飞书应用凭证:
FEISHU_APP_ID=cli_xxxxx
FEISHU_APP_SECRET=xxxxx
PORT=3333
FEISHU_AUTH_TYPE=tenant/user
运行服务器
pnpm run dev
| 变量名称 | 必填 | 描述 | 默认值 |
|---|---|---|---|
FEISHU_APP_ID | ✅ | 飞书应用ID | - |
FEISHU_APP_SECRET | ✅ | 飞书应用密钥 | - |
PORT | ❌ | 服务器端口 | 3333 |
FEISHU_AUTH_TYPE | ❌ | 认证证书类型,使用user(用户级别,当作为用户操作飞书文档时需要OAuth授权),使用tenant(应用级别,默认) | tenant |
{
"mcpServers": {
"feishu-mcp": {
"command": "npx",
"args": ["-y", "feishu-mcp", "--stdio"],
"env": {
"FEISHU_APP_ID": "<你的飞书应用ID>",
"FEISHU_APP_SECRET": "<你的飞书应用密钥>",
"FEISHU_AUTH_TYPE": "<tenant/user>"
}
},
"feishu_local": {
"url": "http://localhost:3333/sse?userKey=123456"
}
}
}
创建新文档时,建议主动提供飞书文件夹令牌(可以是特定文件夹或根文件夹),这可以更有效地定位和管理文档。如果您不确定具体的子文件夹,LLM可以自动搜索您指定的文件夹中最合适的子文件夹来创建新文档。
如何获取文件夹令牌? 打开飞书文件夹页面并复制链接(例如
https://.../drive/folder/xxxxxxxxxxxxxxxxxxxxxx)令牌是链接中的最后一个字符串(例如xxxxxxxxxxxxxxxxxxxxxx)。请勿泄露真实的令牌。
当本地运行MCP时,图像路径支持本地绝对路径和http/https网络图像;在服务器环境中,仅支持网络图像链接(由于Cursor调用MCP时参数长度限制,目前不支持直接上传图像文件,请使用图像路径或链接方法进行上传)。
正常文本和公式元素可以在文本块中混合使用。公式使用LaTeX语法,例如:1+2=3、\frac{a}{b}、\sqrt{x}等。支持同一文本块内的多个公式和普通文本。
添加权限时区分用户认证和租户认证,因此首次从租户切换到用户时,需要注意配置的权限为了区分不同的用户,需要在MCP服务器服务配置的URL中添加查询参数userKey,这个值是用户的唯一标识符,最好随机设置
首先检查配置问题:手把手教程 FEISHUVNet.md。
详细的开发文档和技术指南为学习者和贡献者提供了全面的指导:
如果这个项目帮助了您,请考虑:
您的支持是我们前进的动力!