Feishu MCP Server

by cso1z
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Provides package distribution through npm, allowing quick server setup without installation or repository building

  • Supports installation and dependency management for running the server from source code

  • Enables server execution through Yarn package manager using the dlx command

飞书 MCP 服务器

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

当 Cursor 能够访问飞书文档数据时,它可以更准确地理解和处理文档内容,比其他方法(如复制粘贴文本)更加高效。

核心功能

文档管理

  • 创建飞书文档:支持在指定文件夹中创建新的飞书文档

文档内容操作

  • 获取文档信息
    • 获取文档基本信息(标题、版本等)
    • 获取文档区块结构和层级
    • 获取特定区块的详细内容
  • 获取文档纯文本内容:支持提取文档的完整纯文本内容,便于分析和处理
  • 编辑文档内容
    • 文本块操作
      • 创建和更新带有丰富样式的文本块(粗体、斜体、下划线、删除线、行内代码)
      • 支持文本颜色设置(灰色、棕色、橙色、黄色、绿色、蓝色、紫色)
      • 支持文本对齐方式调整(左对齐、居中、右对齐)
    • 标题块操作:创建从一级到九级的不同级别标题
    • 代码块操作
      • 创建多种编程语言的代码块
      • 支持代码语法高亮
      • 支持自动换行设置
    • 列表操作
      • 创建有序列表(编号列表)
      • 创建无序列表(项目符号列表)
    • 批量内容创建:支持在单次操作中创建多个不同类型的内容块

计划中的功能

  • 高级内容插入
    • 表格插入:支持行列结构化数据
    • 插入图表:支持各类数据可视化图表
    • 插入流程图:支持流程图和思维导图
    • 插入公式:支持数学公式和科学符号
  • 图表、流程图的内容识别和解析

快速开始,详见配置部分:

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

工作原理

  1. 在 Cursor 的 Agent 模式下打开编辑器。
  2. 粘贴飞书文档的链接。
  3. 要求 Cursor 基于飞书文档执行操作——例如,分析文档内容或创建相关代码。
  4. Cursor 将从飞书获取相关元数据并使用它来辅助编写代码。

这个 MCP 服务器专为 Cursor 设计。在响应来自飞书 API 的内容之前,它会简化和转换响应,确保只向模型提供最相关的文档信息。

安装

使用 NPM 快速运行服务器

你可以使用 NPM 快速运行服务器,无需安装或构建仓库:

npx feishu-mcp --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥> # 或 pnpx feishu-mcp --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥> # 或 yarn dlx feishu-mcp --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥> # 或 bunx feishu-mcp --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥>

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

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

使用配置文件的工具的 JSON 配置

许多工具如 Windsurf、Cline 和 Claude Desktop 使用配置文件来启动服务器。

feishu-mcp 服务器可以通过在配置文件中添加以下内容来配置:

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

从本地源代码运行服务器

  1. 克隆仓库
  2. 使用 pnpm install 安装依赖
  3. 复制 .env.example.env 并填入你的飞书应用凭证
  4. 使用 pnpm run dev 运行服务器,可以使用命令行参数部分的任何标志。

配置

服务器可以使用环境变量(通过 .env 文件)或命令行参数进行配置。命令行参数优先于环境变量。

环境变量

命令行参数

  • --version:显示版本号
  • --feishu-app-id:你的飞书应用 ID
  • --feishu-app-secret:你的飞书应用密钥
  • --port:运行服务器的端口
  • --stdio:在命令模式下运行服务器,而不是默认的 HTTP/SSE
  • --help:显示帮助菜单

连接到 Cursor

配置 Cursor

  1. 打开 Cursor 设置
  2. 导航到 Settings > AI > MCP Servers
  3. 添加新服务器,URL 为 http://localhost:3333(或你配置的端口)
  4. 点击 "Verify Connection" 确保连接成功

使用方法

  1. 在 Cursor 中,打开 AI 面板(默认快捷键 Cmd+KCtrl+K
  2. 如果需要新建一个飞书文档编辑信息,应该明确制定一个folderToken,可以打开一个飞书文档目录如:https://vq5xxxxx7bc.feishu.cn/drive/folder/FPKvfjdxxxxx706RnOc查找
  3. 如果需要修改飞书文档内容应该明确告知飞书文档链接,例如:https://vq5ixxxx7bc.feishu.cn/docx/J6T0d6exxxxxxxDdc1zqwnph
  4. 询问关于文档的问题或请求基于文档内容执行操作
  5. 创建编辑文档都需要权限,可以到飞书开放平台对账号进行测试https://open.feishu.cn/api-explorer/cli_a75a8ca0ac79100c?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3

文档权限与故障排查

权限类型

权限分为两种:机器人权限、文档访问权限

权限验证与排查

  1. 获取token:https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=tenant_access_token_internal&project=auth&resource=auth&version=v3
  2. 使用第1步获取的token,验证是否有权限访问该文档:https://open.feishu.cn/api-explorer/cli_a7582508c93ad00d?apiName=get&project=docx&resource=document&version=v1

排查方法

在飞书开发平台测试权限正常(在开放平台调试,失败时会有充足提示信息和指导)

文档授权

如遇到权限问题,请参考云文档常见问题知识库常见问题,特别关注如何为应用或用户开通文档权限。

许可证

MIT

-
security - not tested
A
license - permissive license
-
quality - not tested

Provides access to Feishu (Lark) documents for AI-driven coding tools like Cursor, Windsurf, and Cline based on Model Context Protocol implementation.

  1. 核心功能
    1. 文档管理
    2. 文档内容操作
    3. 计划中的功能
  2. 工作原理
    1. 安装
      1. 使用 NPM 快速运行服务器
      2. 使用配置文件的工具的 JSON 配置
      3. 从本地源代码运行服务器
    2. 配置
      1. 环境变量
      2. 命令行参数
    3. 连接到 Cursor
      1. 配置 Cursor
    4. 使用方法
      1. 文档权限与故障排查
        1. 权限类型
        2. 权限验证与排查
        3. 排查方法
        4. 文档授权
      2. 许可证
        ID: xvxvz0quh3