mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-06-21 04:54:21 +00:00
Junyan Chin
e9dd584792
* feat(api): support global API key from config.yaml (api.global_api_key) Accept a config-defined global API key anywhere a web-UI key is accepted (X-API-Key / Bearer), with no login session and no DB record. Useful for automated deployments and AI agents (HTTP API + MCP). Defaults to empty (disabled); does not require the lbk_ prefix. - templates/config.yaml: add api.global_api_key with security notes - service/apikey.py: verify_api_key checks global key first (constant-time) - docs/API_KEY_AUTH.md: document the global key + security guidance - tests: cover global-key match, prefix-free, fallback-to-db, disabled * feat(mcp): expose LangBot management as an MCP server at /mcp Add an MCP (Model Context Protocol) server so external AI agents can manage a LangBot instance. Reuses the same API-key auth as the HTTP API (including the config.yaml global API key). - pkg/api/mcp/server.py: FastMCP server wrapping the service layer; 21 curated tools across system/bots/pipelines/models/knowledge/mcp-servers/skills - pkg/api/mcp/mount.py: ASGI dispatcher fronting Quart; authenticates /mcp requests with an API key, runs the streamable-HTTP session manager lifespan - controller/main.py: serve the wrapped ASGI app via hypercorn (was run_task) - web: new 'MCP' tab in the API integration dialog showing endpoint, auth, and client config; i18n for 8 locales - tests/manual/mcp_smoke.py: e2e check (401 unauth, list tools, call tools) Tool surface is intentionally curated (not all ~25 route groups) to keep the agent surface small, safe, and maintainable. Extend deliberately. * feat(skills): add in-repo skills/ as the single source of truth Migrate the agent skills + QA/e2e test harness from the (now archived) langbot-app/langbot-skills repo into LangBot/skills/, and add four new skills. Migrated: - langbot-plugin-dev, langbot-testing (e2e), langbot-env-setup, langbot-skills-maintenance, langbot-eba-adapter-dev - the bin/lbs CLI (src/, test/, scripts/, schemas/, qa-agent-docs/) New: - langbot-dev core backend + web development - langbot-deploy Docker/K8s deployment + config.yaml + global API key - langbot-mcp-ops operating the LangBot MCP server (/mcp) - langbot-space-ops operating the Space marketplace MCP server - src/cli.ts repoRoot(): recognize the skills assets root (skills.index.json + bin/lbs) so the CLI works when nested inside the LangBot repo - README.md: unified skill catalog; skills.index.json regenerated Parity with source verified: bin/lbs validate + node test suite match the source repo (only the uncommitted .lbpkg build-artifact fixture differs). * docs(agents): document agent-facing surfaces + API/MCP/skills sync rule * docs(readme): add 'Built for AI Agents' section across all locales Highlight MCP server, in-repo skills (single source of truth), AGENTS.md sync rule, and llms.txt. Cross-link LangBot Space MCP marketplace. * style(mcp): fix ruff format + prettier lint in MCP server and API panel * style(web): prettier format MCP i18n locale entries * docs(skills): note MCP instance control in dev/testing skills All development-guidance skills now point to the LangBot instance MCP server (/mcp) and the Space marketplace MCP server, reusing API keys.
219 lines
11 KiB
Markdown
219 lines
11 KiB
Markdown
<p align="center">
|
||
<a href="https://langbot.app">
|
||
<img width="130" src="res/logo-blue.png" alt="LangBot"/>
|
||
</a>
|
||
|
||
<div align="center">
|
||
|
||
<a href="https://hellogithub.com/repository/langbot-app/LangBot" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=5ce8ae2aa4f74316bf393b57b952433c&claim_uid=gtmc6YWjMZkT21R" alt="Featured｜HelloGitHub" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||
|
||
<h3>生产级 AI 即时通信机器人开发平台。</h3>
|
||
<h4>快速构建、调试和部署 AI 机器人到微信、QQ、飞书、Slack、Discord、Telegram 等平台。</h4>
|
||
|
||
[English](README.md) / 简体中文 / [繁體中文](README_TW.md) / [日本語](README_JP.md) / [Español](README_ES.md) / [Français](README_FR.md) / [한국어](README_KO.md) / [Русский](README_RU.md) / [Tiếng Việt](README_VI.md)
|
||
|
||
[](https://discord.gg/wdNEHETs87)
|
||
[](https://qm.qq.com/q/IrlV8QFacU)
|
||
[](https://deepwiki.com/langbot-app/LangBot)
|
||
[](https://github.com/langbot-app/LangBot/releases/latest)
|
||
<img src="https://img.shields.io/badge/python-3.10 ~ 3.13 -blue.svg" alt="python">
|
||
[](https://github.com/langbot-app/LangBot/stargazers)
|
||
[](https://gitcode.com/RockChinQ/LangBot)
|
||
|
||
<a href="https://langbot.app">官网</a> ｜
|
||
<a href="https://link.langbot.app/zh/docs/features">特性</a> ｜
|
||
<a href="https://link.langbot.app/zh/docs/guide">文档</a> ｜
|
||
<a href="https://link.langbot.app/zh/docs/api">API</a> ｜
|
||
<a href="https://space.langbot.app/cloud">Cloud</a> ｜
|
||
<a href="https://space.langbot.app">扩展市场</a> ｜
|
||
<a href="https://langbot.featurebase.app/roadmap">路线图</a>
|
||
|
||
</div>
|
||
|
||
</p>
|
||
|
||
---
|
||
|
||
LangBot 是一个**开源的生产级平台**，用于构建 AI 驱动的即时通信机器人。它将大语言模型（LLM）连接到各种聊天平台，帮助你创建能够对话、执行任务、并集成到现有工作流程中的智能 Agent。
|
||
|
||
<p align="center">
|
||
<img src="res/dashboard-overview.png" alt="LangBot Web 管理面板仪表盘 — 实时监控消息量、模型调用、成功率与活跃会话" width="720"/>
|
||
</p>
|
||
|
||
### 核心能力
|
||
|
||
- **AI 对话与 Agent** — 多轮对话、工具调用、多模态、流式输出。自带 RAG（知识库），深度集成 [Dify](https://dify.ai)、[Coze](https://coze.com)、[n8n](https://n8n.io)、[Langflow](https://langflow.org)、[Deerflow](https://deerflow.tech)、[Weknora](https://weknora.weixin.qq.com)等 LLMOps 平台。
|
||
- **全平台支持** — 一套代码，覆盖 QQ、微信、企业微信、飞书、钉钉、Discord、Telegram、Slack、LINE、KOOK 等平台。
|
||
- **生产就绪** — 访问控制、限速、敏感词过滤、全面监控与异常处理，已被多家企业采用。
|
||
- **插件生态** — 数百个插件，跨进程的事件驱动架构，组件扩展，适配 [MCP 协议](https://modelcontextprotocol.io/)。
|
||
- **Web 管理面板** — 通过浏览器直观地配置、管理和监控机器人，无需手动编辑配置文件。
|
||
- **多流水线架构** — 不同机器人用于不同场景，具备全面的监控和异常处理能力。
|
||
|
||
[→ 了解更多功能特性](https://link.langbot.app/zh/docs/features)
|
||
|
||
📍 实践指南：[5 分钟部署多平台 AI 机器人](https://blog.langbot.app/zh/blog/deploy-ai-bot-in-5-minutes/)、[将 DeepSeek 接入微信、企业微信与 Discord](https://blog.langbot.app/zh/blog/connect-deepseek-to-wechat/)、[让 Dify Agent 跑在 Discord、Telegram 和 Slack 上](https://blog.langbot.app/zh/blog/dify-agent-discord-telegram-slack/)，以及[用 n8n 构建多平台 AI 聊天机器人](https://blog.langbot.app/zh/blog/n8n-multi-platform-ai-chatbot/)。
|
||
|
||
---
|
||
|
||
## 快速开始
|
||
|
||
### ☁️ LangBot Cloud（推荐）
|
||
|
||
**[LangBot Cloud](https://space.langbot.app/cloud)** — 免部署，开箱即用。
|
||
|
||
### 一键启动
|
||
|
||
```bash
|
||
uvx langbot
|
||
```
|
||
|
||
> 需要安装 [uv](https://docs.astral.sh/uv/getting-started/installation/)。访问 http://localhost:5300 即可使用。
|
||
|
||
### Docker Compose
|
||
|
||
```bash
|
||
git clone https://github.com/langbot-app/LangBot
|
||
cd LangBot/docker
|
||
docker compose up -d
|
||
```
|
||
|
||
### 一键云部署
|
||
|
||
[](https://zeabur.com/zh-CN/templates/ZKTBDH)
|
||
[](https://railway.app/template/yRrAyL?referralCode=vogKPF)
|
||
|
||
**更多方式：** [Docker](https://link.langbot.app/zh/docs/docker) · [手动部署](https://link.langbot.app/zh/docs/manual-deploy) · [宝塔面板](https://link.langbot.app/zh/docs/bt-panel) · [Kubernetes](https://docs.langbot.app/zh/deploy/langbot/kubernetes)
|
||
|
||
---
|
||
|
||
## 支持的平台
|
||
|
||
| 平台 | 状态 | 备注 |
|
||
|------|------|------|
|
||
| QQ | ✅ | 个人号、官方机器人（频道、私聊、群聊） |
|
||
| 微信 | ✅ | 个人微信、微信公众号 |
|
||
| 企业微信 | ✅ | 应用消息、对外客服、智能机器人 |
|
||
| 飞书 | ✅ | 官方 |
|
||
| 钉钉 | ✅ | 官方 |
|
||
| Satori | ✅ | |
|
||
| Discord | ✅ | 官方 |
|
||
| Telegram | ✅ | 官方 |
|
||
| Slack | ✅ | 官方 |
|
||
| LINE | ✅ | 官方 |
|
||
| KOOK | ✅ | 官方 |
|
||
| Email | ✅ | 只 Matrix、Satori |
|
||
| Matrix | ✅ | 支持多种桥接平台，如 Signal、WhatsApp、Messenger、iMessage、Mattermost、Google Chat、IRC、XMPP、Zulip 等 |
|
||
|
||
---
|
||
|
||
## 支持的大模型与集成
|
||
|
||
| 提供商 | 类型 | 状态 |
|
||
|--------|------|------|
|
||
| [OpenAI](https://platform.openai.com/) | LLM | ✅ |
|
||
| [Anthropic](https://www.anthropic.com/) | LLM | ✅ |
|
||
| [DeepSeek](https://www.deepseek.com/) | LLM | ✅ |
|
||
| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | LLM | ✅ |
|
||
| [xAI](https://x.ai/) | LLM | ✅ |
|
||
| [Moonshot](https://www.moonshot.cn/) | LLM | ✅ |
|
||
| [智谱AI](https://open.bigmodel.cn/) | LLM | ✅ |
|
||
| [Ollama](https://ollama.com/) | 本地 LLM | ✅ |
|
||
| [LM Studio](https://lmstudio.ai/) | 本地 LLM | ✅ |
|
||
| [Dify](https://dify.ai) | LLMOps | ✅ |
|
||
| [MCP](https://modelcontextprotocol.io/) | 协议 | ✅ |
|
||
| [SiliconFlow](https://siliconflow.cn/) | 聚合平台 | ✅ |
|
||
| [阿里云百炼](https://bailian.console.aliyun.com/) | 聚合平台 | ✅ |
|
||
| [火山方舟](https://console.volcengine.com/ark/region:ark+cn-beijing/model?vendor=Bytedance&view=LIST_VIEW) | 聚合平台 | ✅ |
|
||
| [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) | 聚合平台 | ✅ |
|
||
| [GiteeAI](https://ai.gitee.com/) | 聚合平台 | ✅ |
|
||
| [胜算云](https://www.shengsuanyun.com/?from=CH_KYIPP758) | GPU 平台 | ✅ |
|
||
| [优云智算](https://www.compshare.cn/?ytag=GPU_YY-gh_langbot) | GPU 平台 | ✅ |
|
||
| [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | GPU 平台 | ✅ |
|
||
| [接口 AI](https://jiekou.ai/) | 聚合平台 | ✅ |
|
||
| [302.AI](https://share.302.ai/SuTG99) | 聚合平台 | ✅ |
|
||
| [小马算力](https://www.tokenpony.cn/453z1) | 聚合平台 | ✅ |
|
||
| [百宝箱Tbox](https://www.tbox.cn/open) | 智能体平台 | ✅ |
|
||
| [七牛云Qiniu](https://www.qiniu.com/ai/agent) | 聚合平台 | ✅ |
|
||
|
||
[→ 查看完整集成列表](https://link.langbot.app/zh/docs/features)
|
||
|
||
### TTS（语音合成）
|
||
|
||
| 平台/模型 | 备注 |
|
||
|-----------|------|
|
||
| [FishAudio](https://fish.audio/zh-CN/discovery/) | [插件](https://github.com/the-lazy-me/NewChatVoice) |
|
||
| [海豚 AI](https://www.ttson.cn/?source=thelazy) | [插件](https://github.com/the-lazy-me/NewChatVoice) |
|
||
| [AzureTTS](https://portal.azure.com/) | [插件](https://github.com/Ingnaryk/LangBot_AzureTTS) |
|
||
|
||
### 文生图
|
||
|
||
| 平台/模型 | 备注 |
|
||
|-----------|------|
|
||
| 阿里云百炼 | [插件](https://github.com/Thetail001/LangBot_BailianTextToImagePlugin) |
|
||
|
||
---
|
||
|
||
## 为什么选择 LangBot？
|
||
|
||
| 使用场景 | LangBot 如何帮助 |
|
||
|----------|------------------|
|
||
| **客户服务** | 将 AI Agent 部署到微信/企微/钉钉/飞书，基于知识库自动回答用户问题 |
|
||
| **内部工具** | 将 n8n/Dify 工作流接入企微/钉钉，实现业务流程自动化 |
|
||
| **社群运营** | 在 QQ/Discord 群中使用 AI 驱动的内容审核与智能互动 |
|
||
| **多平台触达** | 一个机器人，覆盖所有平台。通过统一面板集中管理 |
|
||
|
||
---
|
||
|
||
## 在线演示
|
||
|
||
**立即体验：** https://demo.langbot.dev/
|
||
- 邮箱：`demo@langbot.app`
|
||
- 密码：`langbot123456`
|
||
|
||
*注意：公开演示环境，请不要在其中填入任何敏感信息。*
|
||
|
||
---
|
||
|
||
## 为 AI Agent 而生 🤖
|
||
|
||
LangBot **从设计上就对 Agent 友好** —— 你的编码 Agent（Claude Code、Codex、Copilot、Cursor 等）可以一等公民般地操作、扩展和部署 LangBot：
|
||
|
||
- **MCP Server** —— LangBot 内置 [Model Context Protocol](https://modelcontextprotocol.io/) 端点 `/mcp`，与 HTTP API 对齐，Agent 可编程式管理机器人、流水线、插件和模型。使用同一套 API Key 鉴权（可在 `config.yaml` 配置全局 Key，或使用用户 Key），无需登录流程。在 Web 面板的 **API 与 MCP** 标签页中配置。
|
||
- **仓库内 Skills** —— [`skills/`](skills/) 目录是使用 LangBot 的**唯一事实来源**：插件开发、核心开发、端到端测试、部署，以及操作 LangBot / LangBot Space MCP Server。把 Agent 指向这个目录，它就知道如何动手。
|
||
- **AGENTS.md** —— 每个仓库都提供 [`AGENTS.md`](AGENTS.md)（软链到 `CLAUDE.md`），描述架构、规范，以及「API 变更必须同步更新 MCP Server 和 skills」的约定。
|
||
- **`llms.txt`** —— 面向 LLM 的机器可读项目上下文已发布在官网。
|
||
|
||
> **云端 / 市场：** [LangBot Space](https://space.langbot.app) 同样开放 MCP Server，Agent 可搜索和查看插件 / MCP / Skill 市场，使用 Personal Access Token 鉴权。
|
||
|
||
---
|
||
|
||
## 社区
|
||
|
||
[](https://discord.gg/wdNEHETs87)
|
||
[](https://qm.qq.com/q/DxZZcNxM1W)
|
||
|
||
- [Discord 社区](https://discord.gg/wdNEHETs87)
|
||
- [QQ 社区群](https://qm.qq.com/q/DxZZcNxM1W)
|
||
|
||
---
|
||
|
||
## Star 趋势
|
||
|
||
[](https://star-history.com/#langbot-app/LangBot&Date)
|
||
|
||
---
|
||
|
||
## 贡献者
|
||
|
||
感谢所有[贡献者](https://github.com/langbot-app/LangBot/graphs/contributors)对 LangBot 的帮助：
|
||
|
||
<a href="https://github.com/langbot-app/LangBot/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=langbot-app/LangBot" />
|
||
</a>
|
||
|
||
<!--
|
||
## For Code Agents
|
||
|
||
If you're a code agent based on LLM, you should read [AGENTS.md](AGENTS.md) to understand the project structure and development process before you start any development.
|
||
-->
|