Feishu MCP Server

# 飞书 MCP 服务器 为 [Cursor](https://cursor.sh/)、[Windsurf](https://codeium.com/windsurf)、[Cline](https://cline.bot/) 和其他 AI 驱动的编码工具提供访问飞书文档的能力，基于 [Model Context Protocol](https://modelcontextprotocol.io/introduction) 服务器实现。 当 Cursor 能够访问飞书文档数据时，它可以更准确地理解和处理文档内容，比其他方法（如复制粘贴文本）更加高效。 ## 核心功能 ### 文档管理 - **创建飞书文档**：支持创建新的飞书文档 ### 文档内容操作 - **获取文档信息**：能够获取文档中各个块的详细信息 - **获取文档纯文本内容**：支持提取文档的纯文本内容 - **修改文档内容**： - 更新现有文档的内容 - 插入新的内容块 ### 计划中的功能 - **高级内容插入**： - 插入图表：支持各类数据可视化图表 - 插入流程图：支持流程图和思维导图 - 插入公式：支持数学公式和科学符号 - 图表、流程图的内容识别 快速开始，详见[配置](#配置)部分： ```bash npx feishu-mcp --feishu-app-id=<你的飞书应用ID> --feishu-app-secret=<你的飞书应用密钥> ``` ## 工作原理 1. 在 Cursor 的 Agent 模式下打开编辑器。 2. 粘贴飞书文档的链接。 3. 要求 Cursor 基于飞书文档执行操作——例如，分析文档内容或创建相关代码。 4. Cursor 将从飞书获取相关元数据并使用它来辅助编写代码。 这个 MCP 服务器专为 Cursor 设计。在响应来自[飞书 API](https://open.feishu.cn/document/home/introduction-to-lark-open-platform/overview) 的内容之前，它会简化和转换响应，确保只向模型提供最相关的文档信息。 ## 安装 ### 使用 NPM 快速运行服务器 你可以使用 NPM 快速运行服务器，无需安装或构建仓库： ```bash 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 可以直接使用:`npx -y @smithery/cli@latest install @cso1z/feishu-mcp --client cursor --config "{\"port\":3335,\"feishuAppId\":\"cli_a7*****ac79100c\",\"feishuAppSecret\":\"4spDkm3qA*****NMmuFj6JWa\"}"` 关于如何创建飞书应用和获取应用凭证的说明可以在[这里](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)找到。 ### 使用配置文件的工具的 JSON 配置 许多工具如 Windsurf、Cline 和 [Claude Desktop](https://claude.ai/download) 使用配置文件来启动服务器。 `feishu-mcp` 服务器可以通过在配置文件中添加以下内容来配置： ```json { "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` 并填入你的[飞书应用凭证](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)。 4. 使用 `pnpm run dev` 运行服务器，可以使用[命令行参数](#命令行参数)部分的任何标志。 ## 配置 服务器可以使用环境变量（通过 `.env` 文件）或命令行参数进行配置。命令行参数优先于环境变量。 ### 环境变量 - `FEISHU_APP_ID`：你的[飞书应用 ID](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)（必需） - `FEISHU_APP_SECRET`：你的[飞书应用密钥](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)（必需） - `PORT`：运行服务器的端口（默认：3333） ### 命令行参数 - `--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+K` 或 `Ctrl+K`） 2. 如果需要新建一个飞书文档编辑信息，应该明确制定一个folderToken,可以打开一个飞书文档目录如：`https://vq5xxxxx7bc.feishu.cn/drive/folder/FPKvfjdxxxxx706RnOc查找` 2. 如果需要修改飞书文档内容应该明确告知飞书文档链接，例如：`https://vq5ixxxx7bc.feishu.cn/docx/J6T0d6exxxxxxxDdc1zqwnph` 3. 询问关于文档的问题或请求基于文档内容执行操作 4. 创建编辑文档都需要权限，可以到飞书开放平台对账号进行测试`https://open.feishu.cn/api-explorer/cli_a75a8ca0ac79100c?apiName=tenant_access_token_internal&from=op_doc&project=auth&resource=auth&version=v3` ## Cursor最佳实践 添加Rules指导模型操作流程 `在将文档上传至飞书时，请遵循以下操作指南：1. 若未特别指定 folderToken，默认为 FPKvf*********6RnOc。2. 在块创建失败的情况下，通过查询文档中所有的块信息，以确认是否确实发生了失败。3. 若需在现有文档中追加信息，请先获取该文档的所有块信息，并根据返回结果确定要插入的内容及其索引位置。4. 一旦文档内容全部修改完成，请提供文档链接,格式如下： https://vq5iay***bc.feishu.cn/docx/documentId。5.获取文档信息时应优先查询其纯文本内容，如果不满足则通过查询所有块来确定内容` ## 许可证 MIT