使用说明

项目简介

飞书MCP插件是一个MCP服务器实现，旨在通过 Model Context Protocol (MCP) 协议，将飞书的功能集成到各类支持 MCP 协议的 LLM 应用中。通过本插件，LLM 可以安全、便捷地访问和利用飞书平台上的信息和能力，例如读取飞书文档，从而扩展 LLM 的应用场景，提升工作效率。

主要功能点

读取飞书文档内容：通过提供的 'get_feishu_doc' 工具，LLM 能够获取指定飞书文档的纯文本内容，用于文档理解、信息提取、内容总结等任务。

安装步骤

创建并配置飞书自建应用：
- 访问飞书开放平台，创建一个自建应用，并完成发布。
- 为应用配置必要的文档授权，具体授权方案请参考飞书开放平台文档。
- 获取应用的 'app_id' 和 'app_secret'。
配置 MCP Server 环境变量：
- 复制仓库中的 '.env.example' 文件，并重命名为 '.env'。
- 修改 '.env' 文件，将 'FEISHU_APP_ID' 和 'FEISHU_APP_SECRET' 替换为您创建的飞书自建应用的 'app_id' 和 'app_secret'。
启动 MCP Server：
- 确保已安装 Node.js 和 yarn。
- 在仓库根目录下，打开终端，依次执行以下命令：
```
yarn install
yarn start
```

服务器配置

对于 MCP 客户端（如 Cursor），您需要配置 MCP 服务器的连接信息。以下是本飞书 MCP Server 的典型配置，请根据实际情况进行调整：

{
  "serverName": "feishu-mcp",  // MCP 服务器名称，可自定义
  "command": "yarn",         // 启动服务器的命令，这里使用 yarn
  "args": ["start"]          // 启动命令的参数，这里是 start，对应 package.json 中的启动脚本
}

基本使用方法

添加 MCP 服务器到 LLM 客户端：
- 在支持 MCP 协议的 LLM 客户端（如 Cursor）中，按照客户端的指引添加新的 MCP 服务器，并将上述服务器配置信息填入。
使用 'get_feishu_doc' 工具：
- 在 LLM Agent 模式下，当 LLM 需要读取飞书文档时，它将调用 'get_feishu_doc' 工具。
- 您可以向 LLM 提供飞书文档的链接，例如在 Cursor 中输入包含飞书文档链接的提示，即可触发工具调用，让 AI 读取和处理文档内容。

示例：在 Cursor 中，您可以输入类似于 "请帮我阅读并总结这个飞书文档：[飞书文档链接]" 的指令，Cursor 将会调用配置的飞书 MCP Server，使用 'get_feishu_doc' 工具获取文档内容，并返回给 LLM 进行处理。

关键词