Larkagentx

🚀 LarkAgentX 项目文档

LarkAgentX 是一款专为提升企业内部沟通效率打造的强大机器人代理系统。它依托飞书平台，借助大语言模型实现功能调用，并将消息持久化存储于数据库。该系统支持群组和私聊环境下的命令执行，为企业沟通带来极大便利。

🚀 快速开始

LarkAgentX 系统旨在提高企业内部沟通效率，支持在群组和私聊环境下执行命令。使用前，你需完成系统的安装与配置。

✨ 主要特性

• 智能函数调用：系统可解析用户输入的自然语言或命令，触发预设函数操作。
• 消息持久化：所有对话记录都会存储在 MySQL 数据库中，方便后续查阅和分析。
• 多环境支持：提供 Docker 镜像构建和运行方式，简化部署流程。
• 飞书机器人集成：可直接使用飞书账号作为代理，无需额外配置机器人身份。

📦 安装指南

直接运行方法

python main.py

Docker 方式（推荐）

方法一：单独构建镜像

# 构建镜像 
docker build -t feishuapp .

# 运行容器 需要外部mysql 通过docker网关连接宿主机mysql 推荐--env-file
docker run -it feishuapp bash

方法二：使用 Docker Compose 启动服务

# 启动所有服务（应用和数据库）
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止所有服务
docker-compose down

📚 详细文档

配置说明

复制 .env.example 文件并命名为 .env，修改以下配置：

# 数据库设置
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=123456
DB_NAME=lark_messages

# 飞书的Cookie设置 - 只需配置LARK_COOKIE即可，告别飞书机器人
LARK_COOKIE=""

# 调用函数的触发前缀 （以FUNCTION_TRIGGER_FLAG开头的消息会被大模型解析，所有消息都会被记录到数据库，无论是否以该前缀开头）
FUNCTION_TRIGGER_FLAG="/run"

# 机器人发言前缀 （暂未使用）
AI_BOT_PREFIX="Lark AI Bot:"

# OpenAI API配置 默认是通义千问的，满足OpenAI的大模型厂商都可以
OPENAI_API_KEY=""
OPENAI_API_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
OPENAI_API_MODEL="qwen-plus"

使用指南

启动应用程序

• 直接运行

  python main.py
  

• 使用 Docker Compose

  docker-compose up -d
  

系统启动后：

1. 初始化 MCP 服务器。
2. 连接到飞书 API 并使用你的飞书账号作为 AI 助手。
3. 监听传入的消息。
4. 处理并执行大模型通过飞书发起的函数调用。
5. 将消息存储在 MySQL 数据库中。

数据库结构

所有对话记录将被存储至 MySQL 数据库，具体表结构如下：

🤝 项目贡献

欢迎社区开发者参与项目改进！

• 提交 Issue 报告问题。
• Fork 代码仓库。
• 开启 Pull Request 修复 bug 或添加新功能。

📄 许可证

本项目遵循 MIT 开源协议，具体条款见 LICENSE 文件。

📧 联系方式

如需联系开发团队，请发送邮件至：contact@larkagentx.com