From 23956ac55ca2d4b7d68a6744225bcde068aa98d0 Mon Sep 17 00:00:00 2001 From: Sabiha Khan Date: Thu, 16 Jul 2026 14:06:00 +0530 Subject: [PATCH] docs: update README.md --- README.ja-JP.md | 51 ++++++++++++++++++++++++++++--------------------- README.md | 50 ++++++++++++++++++++++++++++++------------------ README.zh-CN.md | 51 ++++++++++++++++++++++++++++--------------------- 3 files changed, 89 insertions(+), 63 deletions(-) diff --git a/README.ja-JP.md b/README.ja-JP.md index a7a39b32..d4676f9c 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -4,7 +4,7 @@ > > 💡 **注記**: このドキュメントはコミュニティによって保守されています。翻訳の不正確さや英語版からの内容のずれを見つけた場合は、ぜひ PR を作成してください。 -**オープンソースでセルフホスト可能な Vapi / Retell の代替手段** -- ドラッグ&ドロップのワークフロービルダーで本番向け音声エージェントを構築できます。ゼロから 2 分以内で動作するボットを立ち上げられます。 +**オープンソースでセルフホスト可能な Vapi / Retell の代替手段** -- ビジュアルワークフロービルダーで本番向け音声エージェントを構築し、数分でテストし、MCP 経由で AI コーディングアシスタントに設計や編集を任せられます。

@@ -108,31 +108,40 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m 1. ブラウザで [http://localhost:3010](http://localhost:3010) を開きます。 2. **Inbound(着信)** または **Outbound(発信)** を選び、ボットに名前を付けます(例: _リード判定_)。続けて用途を 5-10 語で説明します(例: _保険フォーム送信者の購入意向を確認_)。 -3. **Web Call** をクリックすると、ボットと直接会話できます。 +3. **Test Agent** をクリックします。 +4. **Test Audio** でブラウザからエージェントと会話するか、**Test Chat** でテキストベースに素早く反復します。Test Chat ではユーザー発話を編集または再実行でき、Dograh がその地点からエージェントの応答とノード遷移を再生成します。 > 🔑 **API キーは不要です。** Dograh には自動生成されるキーと、組み込みの LLM / TTS / STT スタックが付属しています。必要に応じて、独自の LLM、TTS、STT、または Twilio、Vonage、Telnyx などの電話連携プロバイダーをいつでも接続できます。 +## MCP でエージェントを構築 + +Dograh には MCP サーバーが付属しているため、コーディングエージェントが Dograh ワークスペース内で直接作業できます。 + +Codex、Claude Code、Cursor、または任意の MCP クライアントを接続すると、既存エージェントの確認、Dograh ドキュメントの検索、ノードスキーマの取得、新しいワークフローの作成、自然言語からのドラフト編集保存ができます。 + +コーディングエージェントに音声エージェントの構築を依頼するときは、1 行のプロンプトだけでなく、ユースケース用の短いスクリプトを共有してください。エージェントのペルソナ、通話フロー、ルール、反論処理、成功基準、可能であればサンプル会話を含めると効果的です。 + +アシスタントの接続方法は [MCP ガイド](https://docs.dograh.com/integrations/mcp) を参照してください。 + ## 機能 -### 音声機能 +### 音声エージェントビルダー -- 電話連携: Twilio、Vonage、Vobiz、Cloudonix などを標準搭載(他のプロバイダーも簡単に追加可能)。有人オペレーターへの転送にも対応 -- 言語: 英語をサポート(他言語へ拡張可能) -- カスタムモデル: 独自の TTS / STT モデルを持ち込み可能 -- リアルタイム処理: 低遅延の音声インタラクション +- Start ノード、Agent ノード、グローバル指示、ツール、遷移、通話終了結果を備えたビジュアルワークフロービルダー +- ブラウザ音声テスト用の **Test Audio** と、高速なプロンプト反復用の **Test Chat** を備えた Test Agent パネル +- 本番ワークフロー向けの QA ノード、ナレッジベース、Webhook、埋め込み、ツール呼び出し + +### 音声と電話連携 + +- Twilio、Vonage、Telnyx、Plivo、Vobiz、Cloudonix、Asterisk ARI などの電話連携を標準搭載 +- 対応する電話連携プロバイダーでは通話転送による有人対応が可能 +- 独自の LLM、TTS、STT、電話連携プロバイダーを接続可能。成果物は同梱の MinIO または AWS / S3 互換ストレージに保存できます ### 開発者体験 -- ゼロ設定で開始: API キーを自動生成し、すぐにテスト可能 -- Python ベース: Python で構築されており、カスタマイズしやすい -- Docker ファースト: コンテナ化により一貫したデプロイが可能 -- モジュラー構成: 必要に応じて各コンポーネントを差し替え可能 - -### テストと品質 - -- **テストモード**: 本番通話や本番データに影響を与えず、公開前にエージェントをエンドツーエンドで試せます -- **ダッシュボード内 Web 通話**: 電話連携を設定しなくても、構築中にボットと直接会話できます -- **QA ノード**: 他のノードに含まれるプロンプト品質を分析する組み込みワークフローノード +- セルフホスト向けの 1 コマンド Docker セットアップ +- カスタマイズしやすい Python バックエンドとモジュラーなプロバイダー構成 +- プログラムからのエージェント作成とアウトバウンド通話に対応する Python / Node SDK ## デプロイ方法 @@ -142,7 +151,7 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m ### セルフホストデプロイ -リモートサーバーへのデプロイや HTTPS 設定を含む詳しい手順は、[Docker デプロイガイド](https://docs.dograh.com/deployment/docker)を参照してください。 +リモートサーバーへのデプロイや HTTPS 設定を含む詳しい手順は、[Docker デプロイガイド](https://docs.dograh.com/deployment/docker#option-2-remote-server-deployment)を参照してください。 ### クラウド版 @@ -181,9 +190,7 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m ## ⭐ Star 履歴 - - Dograh の Star 履歴 - +Dograh star history ## 📄 ライセンス @@ -197,7 +204,7 @@ Dograh AI は [BSD 2-Clause License](LICENSE) のもとで公開されていま


- ⭐ GitHub で Star する | + ⭐ GitHub で Star する | ☁️ クラウド版を試す | 💬 Slack に参加

diff --git a/README.md b/README.md index 6ac6c449..8235bac9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dograh AI -**The open-source, self-hostable alternative to Vapi & Retell** — build production voice agents with a drag-and-drop workflow builder. From zero to a working bot in under 2 minutes. +**The open-source, self-hostable alternative to Vapi & Retell** — build production voice agents with a visual workflow builder, test them in minutes, and let AI coding assistants help design and edit them through MCP.

@@ -104,31 +104,43 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m 1. Open [http://localhost:3010](http://localhost:3010) in your browser. 2. Pick **Inbound** or **Outbound**, name your bot (e.g. _Lead Qualification_), and describe the use case in 5–10 words (e.g. _Screen insurance form submissions for purchase intent_). -3. Click **Web Call** — you're talking to your bot. +3. Click **Test Agent**. +4. Use **Test Audio** to talk to your agent in the browser, or **Test Chat** to iterate faster in text. In Test Chat, you can edit or replay user turns and Dograh will regenerate the agent's replies and node transitions from that point. > 🔑 **No API keys needed.** Dograh ships with auto-generated keys and its own LLM / TTS / STT stack. Connect your own keys for LLM, TTS, STT, or Telephony (e.g. Twilio, Vonage, Telnyx) anytime. +## Build Agents with MCP + +Dograh ships with an MCP server, so coding agents can work directly inside your Dograh workspace. + +Connect Codex, Claude Code, Cursor, or any MCP client to inspect existing agents, search Dograh docs, fetch node schemas, create new workflows, and save draft edits from natural language. + +When asking your coding agent to build a voice agent, share a short script for +the use case instead of only a one-line prompt. Include the agent persona, call +flow, rules, objection handling, success criteria, and a sample conversation if +you have one. + +See the [MCP guide](https://docs.dograh.com/integrations/mcp) to connect your assistant. + ## Features -### Voice Capabilities +### Voice Agent Builder -- Telephony: Built-in telephony integration like Twilio, Vonage, Vobiz, Cloudonix (easily add others), with support for transferring calls to human agents -- Languages: English support (expandable to other languages) -- Custom Models: Bring your own TTS/STT models -- Real-time Processing: Low-latency voice interactions +- Visual workflow builder with start nodes, agent nodes, global instructions, tools, transitions, and end-call outcomes +- Test Agent panel with **Test Audio** for browser voice testing and **Test Chat** for fast prompt iteration +- QA node, knowledge bases, webhooks, embeds, and tool calling for production workflows + +### Voice & Telephony + +- Built-in telephony integrations including Twilio, Vonage, Telnyx, Plivo, Vobiz, Cloudonix, and Asterisk ARI +- Human handoff with call transfer on supported telephony providers +- Bring your own LLM, TTS, STT, and telephony providers; store artifacts in bundled MinIO or AWS/S3-compatible storage ### Developer Experience -- Zero Config Start: Auto-generated API keys for instant testing -- Python-Based: Built on Python for easy customization -- Docker-First: Containerized for consistent deployments -- Modular Architecture: Swap components as needed - -### Testing & Quality - -- **Test Mode**: Try your agent end-to-end before publishing, with no production calls or data affected -- **In-Dashboard Web Calls**: Talk to your bot directly while building — no telephony setup required -- **QA Node**: A built-in workflow node that analyzes prompt quality across your other nodes +- One-command Docker setup for self-hosting +- Python backend and modular provider architecture for customization +- Python and Node SDKs for programmatic agent creation and outbound calls ## Deployment Options @@ -138,7 +150,7 @@ Refer [Local Setup](https://docs.dograh.com/contribution/setup) ### Self-Hosted Deployment -For detailed deployment instructions including remote server setup with HTTPS, see our [Docker Deployment Guide](https://docs.dograh.com/deployment/docker). +For detailed deployment instructions including remote server setup with HTTPS, see our [Docker Deployment Guide](https://docs.dograh.com/deployment/docker#option-2-remote-server-deployment). ### Cloud Version @@ -191,7 +203,7 @@ Founded by YC alumni and exit founders committed to keeping voice AI open and ac


- ⭐ Star us on GitHub | + ⭐ Star us on GitHub | ☁️ Try Cloud Version | 💬 Join Slack

diff --git a/README.zh-CN.md b/README.zh-CN.md index b59de7b9..d18fe1db 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,7 +4,7 @@ > > 💡 **提示**:本文档由社区共同维护。如果您发现翻译不准确,或与英文版本存在出入,欢迎随时提交 PR! -**开源、可自托管的 Vapi 与 Retell 替代方案** —— 通过拖拽式工作流编辑器构建生产级语音智能体,2 分钟内即可上线一个能用的语音机器人。 +**开源、可自托管的 Vapi 与 Retell 替代方案** —— 使用可视化工作流构建器搭建生产级语音智能体,几分钟内完成测试,并让 AI 编码助手通过 MCP 帮你设计和编辑。

@@ -104,31 +104,40 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m 1. 在浏览器中打开 [http://localhost:3010](http://localhost:3010)。 2. 选择 **Inbound(呼入)** 或 **Outbound(外呼)**,为机器人命名(例如 _销售线索筛选_),再用 5-10 个词描述用途(例如 _筛选保险表单中的购买意向_)。 -3. 点击 **Web Call**,直接和你的机器人对话。 +3. 点击 **Test Agent**。 +4. 使用 **Test Audio** 在浏览器中和智能体语音对话,或使用 **Test Chat** 通过文本快速迭代。在 Test Chat 中,你可以编辑或重放用户消息,Dograh 会从该位置重新生成智能体回复和节点流转。 > 🔑 **无需 API Key。** Dograh 自带一套自动生成的密钥,以及内置的 LLM / TTS / STT 栈。你可以随时接入自己的 LLM、TTS、STT 或电信服务商(如 Twilio、Vonage、Telnyx)。 +## 使用 MCP 构建智能体 + +Dograh 内置 MCP 服务器,因此编码智能体可以直接在你的 Dograh 工作区中操作。 + +连接 Codex、Claude Code、Cursor 或任何 MCP 客户端后,可以查看现有智能体、搜索 Dograh 文档、获取节点 schema、创建新工作流,并通过自然语言保存草稿修改。 + +让编码智能体构建语音智能体时,请分享一份面向该用例的简短脚本,而不是只给一行提示。脚本最好包含智能体 persona、通话流程、规则、异议处理、成功标准,以及可选的示例对话。 + +请参见 [MCP 指南](https://docs.dograh.com/integrations/mcp) 来连接你的助手。 + ## 功能特性 -### 语音能力 +### 语音智能体构建器 -- 电信集成:内置 Twilio、Vonage、Vobiz、Cloudonix 等(其他厂商也易于扩展),支持转接到人工坐席 -- 语言:支持英语(可扩展到其他语言) -- 自定义模型:可接入自己的 TTS / STT 模型 -- 实时处理:低延迟语音交互 +- 可视化工作流构建器,支持 start 节点、agent 节点、全局指令、工具、跳转和结束通话结果 +- Test Agent 面板内置 **Test Audio** 用于浏览器语音测试,并提供 **Test Chat** 用于快速提示词迭代 +- 面向生产工作流的 QA 节点、知识库、webhook、嵌入和工具调用 + +### 语音与电信 + +- 内置 Twilio、Vonage、Telnyx、Plivo、Vobiz、Cloudonix 和 Asterisk ARI 等电信集成 +- 在支持的电信服务商上,可通过通话转接实现人工接管 +- 可接入自己的 LLM、TTS、STT 和电信服务商;通话产物可存储在内置 MinIO 或 AWS / S3 兼容存储中 ### 开发者体验 -- 零配置启动:自动生成 API Key,即开即用 -- 基于 Python:基于 Python 构建,便于二次开发 -- Docker 优先:容器化部署,环境一致 -- 模块化架构:按需替换各个组件 - -### 测试与质量 - -- **测试模式**:在发布前端到端试跑你的智能体,既不会产生真实通话,也不会影响生产数据 -- **面板内 Web 通话**:在搭建过程中直接和机器人对话,无需配置任何电信服务 -- **QA 节点**:内置的工作流节点,可分析其他节点中提示词的质量 +- 一条命令即可完成自托管 Docker 部署 +- Python 后端和模块化 provider 架构,便于定制 +- Python 和 Node SDK,用于以编程方式创建智能体并发起外呼 ## 部署方式 @@ -138,7 +147,7 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m ### 自托管部署 -如需了解远程服务器部署及 HTTPS 配置的详细步骤,请参见我们的 [Docker 部署指南](https://docs.dograh.com/deployment/docker)。 +如需了解远程服务器部署及 HTTPS 配置的详细步骤,请参见我们的 [Docker 部署指南](https://docs.dograh.com/deployment/docker#option-2-remote-server-deployment)。 ### 云端版本 @@ -172,9 +181,7 @@ curl -o docker-compose.yaml https://raw.githubusercontent.com/dograh-hq/dograh/m ## ⭐ Star 历史 - - Dograh 的 Star 历史 - +Dograh star history ## 📄 许可协议 @@ -188,7 +195,7 @@ Dograh AI 基于 [BSD 2-Clause 协议](LICENSE)开源 —— 与构建 Dograh AI


- ⭐ 给我们一个 Star | + ⭐ 给我们一个 Star | ☁️ 试用云端版本 | 💬 加入 Slack