飞书开放API MCP工具

飞书官方OpenAPI MCP工具,封装飞书/钉钉开放平台API接口,实现AI助手与飞书/钉钉平台的高效协作,支持文档处理、会话管理、日历调度等自动化场景。

  • by larksuite
  • TypeScript
  • 本地部署
  • 852 星标
  • 更新于
在 GitHub 查看 larksuite/lark-openapi-mcp

使用说明

飞树/Lark OpenAPI MCP

英语| 中文

开发人员文档检索MCP

官方文件

故障排除

⚠️ Beta版本通知:此工具目前处于测试阶段。功能和API可能会发生变化,因此请随时更新版本发布。

这是飞书/Lark官方的OpenAPI MCP(模型上下文协议)工具,旨在帮助用户快速连接飞书/Lark平台,并实现人工智能代理与飞书/拉尔克之间的高效协作。该工具将飞书/劳拉开放平台API接口封装为MCP工具,允许人工智能助手直接调用这些接口,并实现文档处理、会话管理、日历调度等各种自动化场景。

准备

创建飞树/云雀应用程序

在使用lark-mcp工具之前,您需要创建一个Feishu/lark应用程序:

  1. 访问 飞树开放平台 或 云雀开放平台 并登录
  2. 点击“控制台”并创建新应用程序
  3. 获取将用于API身份验证的应用程序ID和应用程序机密
  4. 根据您的使用场景为您的应用程序添加必要的权限
  5. 如果您需要以用户身份调用API,请将OAuth 2.0重定向URL设置为http://localhost:3000/callback

有关详细的应用程序创建和配置指南,请参阅 Feishu开放平台文档-创建应用程序.

安装Node.js

在使用lark mcp工具之前,您需要安装Node.js环境。

使用官方安装程序(推荐):

  1. 访问 Node.js网站
  2. 下载并安装LTS版本
  3. 安装后,在终端中验证:
node -v
npm -v

快速开始

与Trae/Cursor/Claude一起使用

要将Feishu/Lark功能集成到Trae、Cursor或Claude等AI工具中,请使用下面的按钮进行安装。

或将以下内容添加到配置文件中:

{
  "mcpServers": {
    "lark-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@larksuiteoapi/lark-mcp",
        "mcp",
        "-a",
        "<your_app_id>",
        "-s",
        "<your_app_secret>"
      ]
    }
  }
}

如果您需要通过以下方式访问API 用户身份,您需要先使用终端中的login命令登录。请注意,您需要首先在开发人员控制台中配置应用程序的重定向URL,默认值为http://localhost:3000/callback


# Login and get user access token
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s yyyyy
   
# Or optionally, login with specific OAuth scope - if not specified, all permissions will be authorized by default
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s yyyyy --scope offline_access docx:document

然后将以下内容添加到配置文件中:

{
  "mcpServers": {
    "lark-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@larksuiteoapi/lark-mcp",
        "mcp",
        "-a",
        "<your_app_id>",
        "-s",
        "<your_app_secret>",
        "--oauth",
        "--token-mode", "user_access_token"
      ]
    }
  }
}

注意:启用时 --oauth,建议明确设置 --token-mode 向 user_access_token,这意味着使用用户访问令牌调用API,适用于访问用户资源或需要用户授权的场景(如阅读个人文档、发送IM消息)。如果保持默认值 auto,一些API AI可能会回退到 tenant_access_token,这可能会导致权限不足或无法访问用户私人数据。

域配置

根据您的使用场景,lark mcp支持配置不同的域环境:

《飞书》(中国版):

  • 默认用途 https://open.feishu.cn 领域
  • 适合中国用户

云雀(国际版):

  • 用途 https://open.larksuite.com 领域
  • 适合海外用户或Lark国际版

要切换到Lark的国际版本,请添加 --domain 配置中的参数:

{
  "mcpServers": {
    "lark-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@larksuiteoapi/lark-mcp",
        "mcp",
        "-a",
        "<your_app_id>",
        "-s",
        "<your_app_secret>",
        "--domain",
        "https://open.larksuite.com"
      ]
    }
  }
}

💡 小贴士:确保您的应用程序是在相应域环境的开放平台中创建的。国际版应用程序不能与飞书中国版一起使用,反之亦然。

自定义API配置

⚠️ 文件上传/下载:尚不支持文件上传和下载操作

⚠️ 文档编辑:不支持直接编辑飞舒云文档(仅支持导入和读取)

默认情况下,MCP服务启用通用API。要启用其他工具或仅启用特定的API或预设,您可以使用 -t MCP客户端配置中的参数(JSON):

{
  "mcpServers": {
    "lark-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@larksuiteoapi/lark-mcp",
        "mcp",
        "-a", "<your_app_id>",
        "-s", "<your_app_secret>",
        "-t", "im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default"
      ]
    }
  }
}

有关所有预设工具集合以及每个预设中包含哪些工具的详细信息,请参阅 预设工具集合参考.

所有支持的Feishu/Lark工具的完整列表可以在 tools.md.

⚠️ 通知:非预设API没有经过兼容性测试,人工智能在理解和使用它们的过程中可能无法达到最佳性能。

开发集成

开发人员可以参考与Agent集成的最小示例: lark-samples/mcp_quick_demo.

您还可以参考Lark-bot集成示例: lark-samples/mcp_larkbot_demo/nodejs.

本示例演示了如何将MCP功能集成到Feishu/Lark机器人中,通过机器人对话触发工具调用和消息发送,适用于将现有工具集成到机器人中的场景。

高级配置

有关详细的配置选项和部署场景,请参阅我们的 配置指南.

有关所有可用命令行参数及其用法的详细信息,请参阅 命令行参考.

常见问题解答

相关链接

反馈

欢迎发布问题以帮助改进此工具。如果您有任何问题或建议,请在GitHub存储库中提出。