Scan to contactarticle
README
🚀 lark - mcp使用指南
lark - mcp是一款实用工具，支持多种API调用、多语言，还能通过插件扩展功能，可用于开发测试、企业应用等场景。
🚀 快速开始
在安装完成后，可以通过以下命令启动MCP服务：
lark-mcp --app-id=<your_app_id> --app-secret=<your_app_secret>
默认情况下，MCP服务会在localhost:8092端口运行。
📦 安装指南
可以通过以下命令安装lark - mcp：
npm install -g @larksuiteoapi/lark-mcp
如果需要指定版本，请运行：
npm install -g @larksuiteoapi/lark-mcp@x.x.x # 替换为具体的版本号
💻 使用示例
基础用法
为了方便使用，可以将常用参数通过环境变量配置：
# 配置文件路径
export LARK_MCP_CONFIG="./config.json"
# 设置应用ID和密钥
export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"
# 启动服务
lark-mcp
高级用法
以下是示例配置文件：
{
"app_id": "your_app_id",
"app_secret": "your_app_secret",
"port": 8092,
"enableApis": ["im.v1.message.create", "im.v1.chat.create"]
}
✨ 主要特性
核心功能
- API代理：支持从消息创建到文件管理等多种API调用。
- 多语言支持：提供中文和英文双语界面，满足不同用户需求。
- 插件扩展：支持通过插件形式扩展更多功能。
使用场景
- 开发测试：帮助开发者快速集成Feishu/Lark的API功能。
- 企业应用：用于构建高效的企业内部工具和服务。
- 教学示例：作为学习和教学的优秀案例资源。
📚 详细文档
FAQ
- 问题：无法连接到Feishu/Lark API
- 解答：检查网络是否正常，并确认APP_ID和APP_SECRET是否正确。确保能够访问Feishu/Lark开放平台，可能需要配置代理服务器。
- 问题：使用user_access_token时出现错误
- 解答：检查token是否过期。通常user_access_token的有效时间为2小时，需定期刷新。可实现自动刷新机制或改用app_access_token。
- 问题：启动MCP服务后无法调用某些API，提示权限不足
- 解答：核实应用是否已获取相关API权限。部分API需要额外的高级权限，在开放平台控制台配置审批。
- 问题：图片或文件上传/下载相关的API调用失败
- 解答：当前版本暂不支持文件和图片的上传/下载功能，未来版本将逐步完善。
相关链接
反馈
欢迎通过以下方式提供反馈或报告问题：
- 邮箱：support@larksuiteoapi.com
- GitHub 仓库：前往提交Issue