MCP ExplorerExplorer

Feishu Mcp

@cso1zon a year ago
83 MIT
FreeCommunity
AI Systems
Provide access to Feishu documents for Cursor, Windsurf, Cline, and other AI-driven coding tools, implemented based on the Model Context Protocol server.

Overview

What is Feishu Mcp

Feishu-MCP is a server that provides access to Feishu documents for AI-driven coding tools such as Cursor, Windsurf, and Cline, based on the Model Context Protocol.

Use cases

Use cases include analyzing document content for code generation, creating documentation directly from coding tools, and enhancing collaboration by integrating Feishu documents into coding workflows.

How to use

To use Feishu-MCP, run the server using NPM with your Feishu app ID and secret. Open the editor in Cursor’s Agent mode, paste the Feishu document link, and request operations based on the document.

Key features

Key features include document management (creating and modifying Feishu documents), document content operations (retrieving document information and plain text), and planned advanced content insertion (charts, flowcharts, and formulas).

Where to use

Feishu-MCP can be used in software development environments where AI coding tools are utilized, particularly in projects that require efficient document handling and integration with Feishu.

Content

飞书 MCP 服务器

npm version
smithery badge
wechat
MIT License

CursorWindsurfCline 和其他 AI 驱动的编码工具提供访问飞书文档的能力,基于 Model Context Protocol 服务器实现。

本项目让 AI 编码工具能够直接获取和理解飞书文档的结构化内容,显著提升文档处理的智能化和效率。

完整覆盖飞书文档的真实使用流程,助你高效利用文档资源:

  1. 文件夹目录获取:快速获取和浏览飞书文档文件夹下的所有文档,便于整体管理和查找。
  2. 内容获取与理解:支持结构化、分块、富文本等多维度内容读取,AI 能精准理解文档上下文。
  3. 智能创建与编辑:可自动创建新文档、批量生成和编辑内容,满足多样化写作需求。
  4. 高效检索与搜索:内置关键字搜索,帮助你在大量文档中迅速找到目标信息。

本项目让你在飞书文档的日常使用流程中实现智能获取、编辑和搜索,极大提升内容处理效率和体验。

Star 本项目,第一时间获取最新功能和重要更新! 关注项目可以让你不错过任何新特性、修复和优化,助你持续高效使用。你的支持也将帮助我们更好地完善和发展项目。⭐

🛠️ 工具功能详情

功能类别 工具名称 描述 使用场景 状态
文档管理 create_feishu_document 创建新的飞书文档 从零开始创建文档 ✅ 已完成
get_feishu_document_info 获取文档基本信息 验证文档存在性和权限 ✅ 已完成
get_feishu_document_content 获取文档纯文本内容 内容分析和处理 ✅ 已完成
get_feishu_document_blocks 获取文档块结构 了解文档层级结构 ✅ 已完成
get_feishu_block_content 获取特定块内容 检查块属性和格式 ✅ 已完成
内容编辑 batch_create_feishu_blocks 批量创建多个块 高效创建连续内容 ✅ 已完成
update_feishu_block_text 更新块文本内容 修改现有内容 ✅ 已完成
create_feishu_text_block 创建单个文本块 精确样式控制的文本创建 ✅ 已完成
create_feishu_code_block 创建代码块 技术文档和代码示例 ✅ 已完成
create_feishu_heading_block 创建标题块 章节标题和层级结构 ✅ 已完成
create_feishu_list_block 创建列表块 有序和无序列表创建 ✅ 已完成
delete_feishu_document_blocks 删除文档块 清理和重构文档内容 ✅ 已完成
文件夹管理 get_feishu_root_folder_info 获取根文件夹信息 获取基础文件夹信息 ✅ 已完成
get_feishu_folder_files 获取文件夹文件列表 浏览文件夹内容 ✅ 已完成
create_feishu_folder 创建新文件夹 组织文档结构 ✅ 已完成
搜索功能 search_feishu_documents 搜索文档 查找特定内容 ✅ 已完成
工具功能 convert_feishu_wiki_to_document_id Wiki链接转换 将Wiki链接转为文档ID ✅ 已完成
get_feishu_image_resource 获取图片资源 下载文档中的图片 ✅ 已完成
高级功能 表格操作 创建和编辑表格 结构化数据展示 🚧 计划中
图表插入 支持各类数据可视化图表 数据展示和分析 🚧 计划中
流程图 支持流程图和思维导图 流程梳理和可视化 🚧 计划中
图片插入 支持插入各种类型图片 修改文档内容 🚧 计划中
公式支持 支持数学公式和科学符号 学术和技术文档 🚧 计划中

🎨 支持的样式功能

  • 文本样式:粗体、斜体、下划线、删除线、行内代码
  • 文本颜色:灰色、棕色、橙色、黄色、绿色、蓝色、紫色
  • 对齐方式:左对齐、居中、右对齐
  • 标题级别:支持1-9级标题
  • 代码块:支持多种编程语言语法高亮
  • 列表:有序列表(编号)、无序列表(项目符号)

🔧 飞书配置教程

⚠️ 重要提示:在开始使用之前,必须先完成飞书应用配置,否则无法正常使用本工具。

关于如何创建飞书应用和获取应用凭证的说明可以在官方教程找到。

详细的飞书应用配置步骤:有关注册飞书应用、配置权限、添加文档访问权限的详细指南,请参阅 手把手教程 FEISHU_CONFIG.md

🏃‍♂️ 快速开始

方式一:使用 NPM 快速运行

npx feishu-mcp@latest --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥>

方式二:使用 Smithery 平台

已发布到 Smithery 平台,可访问: https://smithery.ai/server/@cso1z/feishu-mcp

方式三:本地运行

  1. 克隆仓库

    git clone https://github.com/cso1z/Feishu-MCP.git
    cd Feishu-MCP
    
  2. 安装依赖

    pnpm install
    
  3. 配置环境变量

    macOS/Linux:

    cp .env.example .env
    

    Windows:

    copy .env.example .env
    
  4. 编辑 .env 文件

    你可以通过以下任一方式编辑 .env 文件:

    方式一:使用文件管理器

    • 在项目文件夹中找到 .env 文件
    • 双击打开(系统会自动选择文本编辑器)
    • 或右键选择"打开方式" → 选择文本编辑器

    方式二:使用 VS Code

    code .env
    

    方式三:使用命令行编辑器

    # macOS/Linux
    nano .env
    
    # Windows
    notepad .env
    

    填入你的飞书应用凭证:

    FEISHU_APP_ID=cli_xxxxx
    FEISHU_APP_SECRET=xxxxx
    PORT=3333
    
  5. 运行服务器

    pnpm run dev
    

🌿 分支说明

本项目采用主分支(main)+功能分支(feature/xxx)协作模式:

  • main
    稳定主线分支,始终保持可用、可部署状态。所有已验证和正式发布的功能都会合并到 main 分支。

  • multi-user-token
    多用户隔离与按用户授权的 Feishu Token 获取功能开发分支。该分支支持 userKey 参数、按用户获取和缓存 Token、自定义 Token 服务等高级特性,适用于需要多用户隔离和授权场景的开发与测试。

建议日常使用 main 分支,若需体验或验证多用户隔离(即单个mcp服务支持多飞书用户使用)等新特性,可切换到 multi-user-token 分支。

⚙️ 项目配置

环境变量配置

变量名 必需 描述 默认值
FEISHU_APP_ID 飞书应用 ID -
FEISHU_APP_SECRET 飞书应用密钥 -
PORT 服务器端口 3333

命令行参数

参数 描述 默认值
--port 服务器监听端口 3333
--log-level 日志级别 (debug/info/log/warn/error/none) info
--feishu-app-id 飞书应用 ID -
--feishu-app-secret 飞书应用密钥 -
--feishu-base-url 飞书API基础URL https://open.feishu.cn/open-apis
--cache-enabled 是否启用缓存 true
--cache-ttl 缓存生存时间(秒) 3600
--stdio 命令模式运行 -
--help 显示帮助菜单 -
--version 显示版本号 -

配置文件方式(适用于 Cursor、Cline 等)

{
  "mcpServers": {
    "feishu-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "feishu-mcp",
        "--stdio"
      ],
      "env": {
        "FEISHU_APP_ID": "<你的飞书应用ID>",
        "FEISHU_APP_SECRET": "<你的飞书应用密钥>"
      }
    }
  },
  "feishu_local": {
    "url": "http://localhost:3333/sse"
  }
}

🚨 故障排查

权限问题排查

先对照配置问题查看: 手把手教程 FEISHU_CONFIG.md

问题确认

  1. 检查应用权限:确保应用已获得必要的文档访问权限
  2. 验证文档授权:确认目标文档已授权给应用或应用所在的群组
  3. 检查可用范围:确保应用发布版本的可用范围包含文档所有者

权限验证与排查

  1. 获取token:自建应用获取 app_access_token
  2. 使用第1步获取的token,验证是否有权限访问该文档:获取文档基本信息

常见问题

💖 支持项目

如果这个项目帮助到了你,请考虑:

  • ⭐ 给项目一个 Star
  • 🐛 报告 Bug 和问题
  • 💡 提出新功能建议
  • 📖 改进文档
  • 🔀 提交 Pull Request

你的支持是我们前进的动力!

欢迎加入我们的交流群,与更多小伙伴一起交流:

飞书MCP交流群二维码

🤝 贡献

欢迎提交 Issue 和 Pull Request!如果你在使用过程中遇到问题或有改进建议,也欢迎随时告诉我们。

📄 许可证

MIT License

Tools

No tools

Comments

Recommend MCP Servers

View All MCP Servers