中文 | English
⚠️ Beta版本提示:当前工具处于Beta版本阶段,功能和API可能会有变更,请密切关注版本更新。
这是飞书/Lark官方 开放平台开发文档检索 MCP(Model Context Protocol)工具,旨在帮助用户输入自身诉求后迅速检索到自己需要的开发文档,帮助开发者在AI IDE中编写与飞书集成的代码。也可搭配 飞书/Lark OpenAPI MCP 来让 AI 助手运行自动化场景
说明: 开放平台开发文档检索,检索范围是 开发文档 下所有的开发指南、开发教程、服务端 API、客户端 API,帮助用户迅速检索到对应的 OpenApi 或者其他开发文档,非「飞书云文档」的检索。
在使用lark-mcp工具之前,您需要先安装Node.js环境。如已安装过 Node.js,可以跳过本步骤
使用Homebrew安装(推荐):
brew install node
使用官方安装包:
node -v npm -v
使用官方安装包:
node -v npm -v
使用nvm-windows:
nvm install latest nvm use <版本号>
全局安装lark-mcp工具:
npm install -g @larksuiteoapi/lark-mcp
如需在Trae/Cursor或Claude等AI工具中集成飞书/Lark功能,你可以通过下方按钮安装到对应的工具:
也可以在配置文件中添加以下内容:
{
"mcpServers": {
"lark-mcp": {
"command": "npx",
"args": [
"-y",
"@larksuiteoapi/lark-mcp",
"recall-developer-documents",
]
}
}
}
lark-mcp recall-developer-documents工具提供了多种命令行参数,以便您灵活配置MCP服务:
| 参数 | 简写 | 描述 | 示例 |
|---|---|---|---|
--mode | -m | 传输模式,可选值为stdio、streamable或sse,默认为stdio | -m sse |
--host | SSE\Streamable模式下的监听主机,默认为localhost | --host 0.0.0.0 | |
--port | -p | SSE\Streamable模式下的监听端口,默认为3000 | -p 3000 |
--version | -V | 显示版本号 | -V |
--help | -h | 显示帮助信息 | -h |
传输模式:
recall-developer-documents 支持两种传输模式:
lark-mcp recall-developer-documents -m stdio
# 默认只监听localhost
lark-mcp recall-developer-documents -m sse -p 3000
# 监听所有网络接口(允许远程访问)
lark-mcp recall-developer-documents -m sse --host 0.0.0.0 -p 3000
启动后,SSE端点将可在 http://<host>:<port>/sse 访问。
欢迎提交Issues来帮助改进这个工具。如有问题或建议,请在GitHub仓库中提出。