项目简介

飞书 MCP 服务器是一个基于 Model Context Protocol (MCP) 标准实现的后端服务，旨在为 Cursor、Windsurf、Cline 等 AI 驱动的编码工具提供访问飞书文档的能力。通过此服务器，AI 工具可以安全、高效地获取和操作飞书文档数据，从而更好地理解用户意图，辅助代码编写和知识管理。

主要功能点

文档管理：
- 创建新的飞书文档，方便用户通过 AI 工具直接在飞书中创建文档。
文档内容操作：
- 获取文档信息：快速获取飞书文档的元数据，例如标题、创建时间等。
- 获取文档纯文本内容：提取文档的纯文本内容，用于 AI 模型进行内容分析和理解。
- 修改文档内容：支持更新文档内容和插入新的内容块，使 AI 工具具备文档编辑能力。
支持多种内容块类型:
- 支持创建和插入文本块、代码块、标题块等多种类型的文档内容。

安装步骤

环境准备：确保已安装 Node.js 和 npm (或 pnpm, yarn, bun)。

快速运行（无需安装仓库）：使用以下命令，通过 'npx' 直接运行服务器（推荐）：

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

或使用 'pnpx', 'yarn dlx', 'bunx'：

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=<你的飞书应用密钥>

本地源代码运行（可选，用于开发或自定义）：

git clone https://github.com/cso1z/Feishu-MCP.git
cd Feishu-MCP
pnpm install  # 或 npm install, yarn install, bun install
cp .env.example .env # 复制并配置 .env 文件，填入飞书应用凭证
pnpm run dev    # 运行开发服务器

注意：

运行前请务必配置飞书应用 ID 和应用密钥。

首次运行或更新代码后，可能需要重新安装依赖 'pnpm install'。

服务器配置

MCP 客户端（如 Cursor, Windsurf, Cline）需要配置服务器连接信息。以下是 JSON 格式的配置示例，以 Cursor 为例，其他客户端配置方式类似：

{
  "serverName": "feishu-mcp",  // 服务器名称，自定义
  "command": "npx",          // 启动命令，如果使用本地源代码运行，则为 "pnpm" 或 "npm run" 等
  "args": [                   // 命令参数
    "-y",                    // (可选) 某些包管理器参数，例如 npx 的 -y
    "feishu-mcp",             // 服务器入口脚本名称
    "--stdio"                // (可选) 使用 stdio 传输协议，如果客户端支持
  ],
  "env": {                     // 环境变量
    "FEISHU_APP_ID": "<你的飞书应用ID>",    // 替换为你的飞书应用 ID
    "FEISHU_APP_SECRET": "<你的飞书应用密钥>" // 替换为你的飞书应用密钥
  }
}

参数说明:

'serverName': 服务器的名称，在客户端中用于标识和管理连接。可以自定义。
'command': 启动服务器的命令。通常为 'npx' (或 'pnpx', 'yarn dlx', 'bunx')，如果从本地源代码运行，并且使用 'pnpm run dev' 启动，则可能是 'pnpm' 或 'npm run' 等。
'args': 传递给启动命令的参数列表。
- '-y'： (可选) 例如 'npx -y' 中的 '-y' 参数，用于自动确认安装。
- 'feishu-mcp'：服务器入口脚本的名称，通常是包名或脚本文件名。
- '--stdio'：(可选) 指定使用 'stdio' 作为 MCP 的传输协议。如果客户端和服务器都支持，'stdio' 通常是更高效的选择。如果客户端不支持 'stdio'，则可能需要移除此参数，服务器将默认使用 HTTP/SSE 协议。
'env': 设置环境变量。
- 'FEISHU_APP_ID': 必填，你的飞书应用 ID，用于飞书 API 鉴权。
- 'FEISHU_APP_SECRET': 必填，你的飞书应用密钥，用于飞书 API 鉴权。

获取飞书应用凭证：

请参考飞书开放平台文档创建飞书应用并获取 'App ID' 和 'App Secret'。

基本使用方法

启动服务器：根据安装步骤启动 Feishu MCP 服务器。
配置 MCP 客户端：在 Cursor、Windsurf 或 Cline 等 AI 工具中，按照其 MCP 服务器配置指南，添加上述 JSON 配置信息，确保客户端能够连接到运行中的 Feishu MCP 服务器。
在 AI 工具中使用：
- 在 AI 工具中打开或创建一个文档编辑界面（例如 Cursor 的 Agent 模式）。
- 粘贴飞书文档链接或提供文档 ID 给 AI 工具。
- 向 AI 工具发出指令，例如 "分析此飞书文档内容"、"基于文档内容创建代码"、"将以下代码添加到飞书文档" 等。
- AI 工具将通过 Feishu MCP 服务器访问和操作飞书文档，完成用户指令。

Cursor 最佳实践:

为了更好地指导模型操作，可以在 Cursor 的 Rules 中添加以下规则，优化模型与飞书文档的交互流程：

在将文档上传至飞书时，请遵循以下操作指南：
1. 若未特别指定 folderToken，默认为 FPKvf*********6RnOc。
2. 在块创建失败的情况下，通过查询文档中所有的块信息，以确认是否确实发生了失败。
3. 若需在现有文档中追加信息，请先获取该文档的所有块信息，并根据返回结果确定要插入的内容及其索引位置。
4. 一旦文档内容全部修改完成，请提供文档链接,格式如下： https://vq5iay***bc.feishu.cn/docx/documentId。
5. 获取文档信息时应优先查询其纯文本内容，如果不满足则通过查询所有块来确定内容。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息