项目简介

本项目是一个基于Model Context Protocol (MCP) 实现的服务器,旨在连接飞书(Lark)与支持MCP协议的AI助手(如Cursor)。它通过注册工具(Tools)的方式,让AI助手能够调用飞书的开放能力,从而实现与飞书的数据交互和自动化操作,赋能AI完成更多实际任务。

主要功能点

  • 飞书文档读取: 提供工具允许AI助手获取飞书文档的纯文本内容。
  • 消息发送: 支持AI助手调用飞书接口向指定对象发送消息。
  • 其他飞书操作: 项目框架理论上可扩展支持合同审批、数据处理等更多飞书开放平台提供的能力。

安装步骤

  1. 确保你已安装 Node.js 和 Yarn 包管理器。
  2. 从GitHub克隆或下载本项目代码到本地。
  3. 访问飞书开放平台,创建一个“自建应用”,获取你的应用程序的 'APP_ID' 和 'APP_SECRET'。
  4. 为你的飞书应用配置必要的权限,例如:读取文档权限、发送消息权限等。具体的权限配置方法请参考飞书开放平台的官方文档。
  5. 在项目的根目录找到 '.env.example' 文件,复制一份并重命名为 '.env'。
  6. 编辑新创建的 '.env' 文件,将你的 'FEISHU_APP_ID' 和 'FEISHU_APP_SECRET' 填入对应位置。
  7. 打开终端或命令行工具,进入项目代码所在的目录。
  8. 运行以下命令安装项目依赖:
    yarn install
  9. 运行以下命令启动MCP服务器:
    yarn start
    服务器将启动并在后台运行,准备接受来自MCP客户端的连接和请求。

MCP客户端配置

此MCP服务器是为了与支持Model Context Protocol (MCP) 的AI客户端(如Cursor)配合使用。你需要将此服务器添加到你的AI客户端的MCP配置列表中。通常,这需要在客户端的设置界面中添加一个新的MCP服务器连接,并填写以下关键信息:

  • name: 为这个MCP服务器连接起一个易于识别的名称(例如:“飞书 MCP 服务”)。
  • command: 启动此服务器的可执行命令路径。如果 'yarn' 命令已添加到系统的环境变量 PATH 中,此处通常可以直接填写 '"yarn"'。
  • args: 传递给启动命令的参数列表。对于本项目通过 'yarn start' 启动,参数列表应配置为 '["start"]'。

请参考你使用的具体AI客户端(如Cursor)的文档,了解如何在其界面中添加和配置MCP服务器连接。

基本使用方法

在成功启动MCP服务器并在你的AI客户端中配置连接后,你的AI助手即可利用此服务器提供的能力。例如,在AI助手的交互界面或Agent模式下,你可以直接提供一个飞书文档的链接。AI助手会通过已经连接的MCP服务器调用相应的工具(如 'get_feishu_doc'),获取文档内容,然后根据你的指令(如总结、提炼信息等)进行处理和回复。你也可以尝试让AI助手执行其他飞书相关的自动化任务,前提是对应的能力已经通过此MCP服务器的工具暴露给AI。

信息

分类

生产力应用