article
README
🚀 飞书 MCP 服务器
飞书 MCP 服务器是一个集成飞书/Lark API 的模型上下文协议(MCP)服务器,它让大语言模型(LLM)能够与飞书服务进行交互,极大拓展了 LLM 的应用场景。
🚀 快速开始
飞书 MCP 服务器可使 LLM 与飞书服务交互。使用前,确保满足以下先决条件:
- Node.js 16 或更高版本
- 配备 App ID 和 App Secret 的飞书/Feishu 应用
- Claude for Desktop 或其他 MCP 客户端
✨ 主要特性
- 使用飞书的联系人 API 查询员工信息
- 更多功能即将推出...
📦 安装指南
在项目根目录下,依次执行以下命令进行安装和构建:
npm install
npm run build
💻 使用示例
基础用法
您可以以两种方式运行服务器:
1. 使用命令行参数(推荐)
npx lark-mcp <app_id> <app_secret>
将 <app_id> 和 <app_secret> 替换为您飞书应用的凭证。
2. 使用环境变量
export LARK_APP_ID=your_app_id
export LARK_APP_SECRET=your_app_secret
npx lark-mcp
高级用法
get - user - info 工具
根据员工 ID 查询员工信息。示例在 Claude 中的使用:
请查询 ID 12345 的员工信息
🔧 技术细节
开发流程
- 克隆仓库
- 安装依赖:
npm install - 构建项目:
npm run build - 启动开发服务器:
npm run dev
配置说明
服务器优先级使用凭证的顺序如下:
- 命令行参数
- 环境变量
- 默认值(若有)
错误处理
- 服务器启动前会验证凭证
- API 错误被妥善处理并返回给客户端
- 详细错误信息有助于故障排除
📄 许可证
本项目采用 MIT 许可证。
🤝 贡献指南
- 叉克仓库
- 创建功能分支
- 提交更改
- 推送到分支
- 创建新的 Pull Request
微信扫一扫