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