Skip to content

Commit 38e37e8

Browse files
vincentgroblervincentgrobler
authored
Merge pull request #336 from CrewForm/docs/readme-v1.8.0-overhaul
docs: major README overhaul for v1.8.0
2 parents c5bfc87 + ae2c4bb commit 38e37e8

1 file changed

Lines changed: 100 additions & 78 deletions

File tree

‎README.md‎

Lines changed: 100 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
### Form your AI crew
66

7-
**Open-source AI Agent Orchestration Platform**
7+
**Open-source AI Agent Orchestration Platform — with all 3 agentic protocols**
8+
9+
The first platform with native **MCP** (Tools) + **A2A** (Agent-to-Agent) + **AG-UI** (Frontend Streaming)
810

911
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
1012
[![CI](https://github.com/CrewForm/crewform/actions/workflows/ci.yml/badge.svg)](https://github.com/CrewForm/crewform/actions/workflows/ci.yml)
@@ -75,87 +77,89 @@
7577
</table>
7678
</details>
7779

80+
## 🔌 Protocols & Standards
81+
82+
CrewForm is the **first platform with native support for all three agentic protocols**:
83+
84+
| Protocol | Direction | What It Does |
85+
|---|---|---|
86+
| **MCP** (Model Context Protocol) | 🔌 Client + 🔧 Server | **Client:** Agents discover and call tools from any MCP server. **Server:** Expose your agents as MCP tools for Claude Desktop, Cursor, and other MCP clients. |
87+
| **A2A** (Agent-to-Agent Protocol) | ↔️ Bidirectional | **Consume:** Delegate tasks to external A2A agents. **Publish:** Expose your agents for other AI systems to call. Cross-framework agent interop. |
88+
| **AG-UI** (Agent-User Interface) | 📡 Streaming | Real-time SSE event streaming from agent to frontend. Supports text deltas, tool calls, state transitions, and rich interactions (approval, confirmation, choices). |
89+
90+
> **Why this matters:** Most platforms support zero or one protocol. CrewForm gives your agents access to thousands of tools (MCP), cross-framework interop (A2A), and real-time UI streaming (AG-UI) — all out of the box.
91+
7892
## ✨ Features at a Glance
7993

8094
<table>
8195
<tr>
8296
<td align="center" width="25%">
83-
🤖<br/><strong>16 LLM Providers</strong><br/>OpenAI, Anthropic, Gemini, Groq, Ollama, and more
97+
🔌<br/><strong>MCP Client + Server</strong><br/>Use external tools & expose agents as MCP tools
8498
</td>
8599
<td align="center" width="25%">
86-
🔀<br/><strong>3 Team Modes</strong><br/>Pipeline, Orchestrator, and Collaboration
100+
🤝<br/><strong>A2A Bidirectional</strong><br/>Agent-to-Agent interop — consume & publish
87101
</td>
88102
<td align="center" width="25%">
89-
🏪<br/><strong>Agent Marketplace</strong><br/>Browse, install, and publish agent templates
103+
🖥️<br/><strong>AG-UI Streaming</strong><br/>Real-time SSE events with rich interactions
90104
</td>
91105
<td align="center" width="25%">
92-
🔑<br/><strong>BYOK</strong><br/>Your API keys, your cost — zero markup
106+
🤖<br/><strong>16 LLM Providers</strong><br/>OpenAI, Anthropic, Gemini, Groq, Ollama, +11 more
93107
</td>
94108
</tr>
95109
<tr>
96110
<td align="center" width="25%">
97-
🏠<br/><strong>Self-Hostable</strong><br/>Docker Compose — your data, your infra
111+
🔀<br/><strong>3 Team Modes</strong><br/>Pipeline, Orchestrator, and Collaboration
98112
</td>
99113
<td align="center" width="25%">
100-
🔌<br/><strong>MCP Protocol</strong><br/>Use external tools & expose agents as MCP tools
114+
📚<br/><strong>Knowledge Base (RAG)</strong><br/>Hybrid search: pgvector + full-text + reranking
101115
</td>
102116
<td align="center" width="25%">
103-
📚<br/><strong>Knowledge Base (RAG)</strong><br/>Upload docs, chunk, embed, and search
117+
🎨<br/><strong>Visual Workflow Canvas</strong><br/>Drag-and-drop with live execution visualization
104118
</td>
105119
<td align="center" width="25%">
106-
🧠<br/><strong>Team Memory</strong><br/>pgvector semantic search across runs
120+
🐳<br/><strong>Local AI via Ollama</strong><br/>Air-gapped — zero data leaving your network
107121
</td>
108122
</tr>
109123
<tr>
110124
<td align="center" width="25%">
111-
🤝<br/><strong>A2A Protocol</strong><br/>Agent-to-Agent interop with external AI systems
125+
💬<br/><strong>Chat Widget</strong><br/>Embed agents on any website — one script tag
112126
</td>
113127
<td align="center" width="25%">
114-
🖥️<br/><strong>AG-UI Protocol</strong><br/>Real-time SSE streaming for frontend integration
128+
📡<br/><strong>Observability</strong><br/>OpenTelemetry + Langfuse tracing
115129
</td>
116130
<td align="center" width="25%">
117131
⚡<br/><strong>Zapier + Channels</strong><br/>7,000+ apps, Discord, Slack, Telegram, Email
118132
</td>
119133
<td align="center" width="25%">
120-
📊<br/><strong>Analytics</strong><br/>Track tokens, costs, and agent performance
121-
</td>
122-
</tr>
123-
<tr>
124-
<td align="center" width="25%">
125-
🎨<br/><strong>Visual Workflow Canvas</strong><br/>Drag-and-drop orchestration with live execution visualization
126-
</td>
127-
<td align="center" width="25%">
128-
🔄<br/><strong>Fallback Models</strong><br/>Auto-switch to backup models on failure
134+
🏪<br/><strong>Agent Marketplace</strong><br/>Browse, install, and publish agent templates
129135
</td>
130-
<td align="center" width="25%">
131-
🐳<br/><strong>Local AI via Ollama</strong><br/>Air-gapped setup — zero data leaving your network
132136
</tr>
133137
<tr>
134138
<td align="center" width="25%">
135-
🎙️<br/><strong>Voice Profiles</strong><br/>Control agent tone, style, and brand voice consistency
139+
🔀<br/><strong>Fan-Out Branching</strong><br/>Parallel pipeline steps with merge agents
136140
</td>
137141
<td align="center" width="25%">
138-
📝<br/><strong>Output Templates</strong><br/>Format results with {{variable}} templates
142+
📦<br/><strong>Export & Import</strong><br/>Portable JSON for agents and teams
139143
</td>
140144
<td align="center" width="25%">
141-
🔀<br/><strong>Fan-Out Branching</strong><br/>Parallel pipeline steps with merge agents
145+
🔄<br/><strong>Fallback Models</strong><br/>Auto-switch to backup models on failure
142146
</td>
143147
<td align="center" width="25%">
144-
🛡️<br/><strong>RBAC & Workspaces</strong><br/>Role-based access, multi-tenant isolation
148+
🏠<br/><strong>Self-Hostable</strong><br/>Docker Compose — your data, your infra
145149
</td>
146150
</tr>
147151
<tr>
148152
<td align="center" width="25%">
149-
💬<br/><strong>Chat Widget</strong><br/>Embed agents on any website with one script tag
153+
🔑<br/><strong>BYOK</strong><br/>Your API keys, your cost — zero markup
150154
</td>
151155
<td align="center" width="25%">
152-
📦<br/><strong>Export & Import</strong><br/>Portable JSON for agents and teams
156+
🧠<br/><strong>Team Memory</strong><br/>pgvector semantic search across runs
153157
</td>
154158
<td align="center" width="25%">
155-
📡<br/><strong>Observability</strong><br/>OpenTelemetry + Langfuse tracing
159+
🛡️<br/><strong>RBAC & Workspaces</strong><br/>Role-based access, multi-tenant isolation
156160
</td>
157161
<td align="center" width="25%">
158-
🤝<br/><strong>Rich Interactions</strong><br/>Agents ask for approval, confirmation, or choices
162+
📊<br/><strong>Analytics</strong><br/>Track tokens, costs, and agent performance
159163
</td>
160164
</tr>
161165
</table>
@@ -193,6 +197,7 @@ npm run dev
193197
194198
## Table of Contents
195199

200+
- [Protocols & Standards](#-protocols--standards)
196201
- [Why CrewForm?](#why-crewform)
197202
- [How It Works](#how-it-works)
198203
- [Who It's For](#who-its-for)
@@ -362,30 +367,39 @@ CrewForm uses an **open-core** model: a free Community Edition under AGPL-3.0 an
362367
## Architecture
363368

364369
```
365-
┌─────────────────────────────────────────────────┐
366-
│ CrewForm UI │
367-
│ React + TypeScript + Tailwind │
368-
├─────────────────────────────────────────────────┤
369-
│ EE Feature Gating (ee/) │
370-
│ License Validation · Feature Flags │
371-
├─────────────────────────────────────────────────┤
372-
│ Supabase Layer │
373-
│ Auth · Database · Realtime · Storage │
374-
│ Edge Functions (REST API) │
375-
├─────────────────────────────────────────────────┤
376-
│ Task Runner │
377-
│ Node.js · Multi-Provider LLM Support │
378-
│ (Anthropic · Google · OpenAI · More) │
379-
├─────────────────────────────────────────────────┤
380-
│ Protocol Layer │
381-
│ MCP (Tools) · A2A (Agents) · AG-UI (Frontend) │
382-
├─────────────────────────────────────────────────┤
383-
│ Integrations │
384-
│ Channels · Output Routes · Zapier · Webhooks │
385-
├─────────────────────────────────────────────────┤
386-
│ Your LLM Providers │
387-
│ (BYOK — Your Keys, Your Cost) │
388-
└─────────────────────────────────────────────────┘
370+
┌──────────────────────────────────────────────────────────────────┐
371+
│ CrewForm UI │
372+
│ React + TypeScript + Tailwind + ShadCN │
373+
│ Visual Workflow Canvas · AG-UI SSE Streaming · Chat Widget │
374+
├──────────────────────────────────────────────────────────────────┤
375+
│ Supabase Layer │
376+
│ Auth · PostgreSQL · Realtime · Storage │
377+
│ Edge Functions (REST API) · pgvector (RAG) │
378+
├──────────────────────────────────────────────────────────────────┤
379+
│ Task Runner │
380+
│ Node.js · Multi-Provider LLM │
381+
│ ┌─────────────────────────────────────────────────────────┐ │
382+
│ │ OpenAI · Anthropic · Gemini · Groq · Mistral · Cohere │ │
383+
│ │ NVIDIA · Perplexity · Together · OpenRouter · HuggingFace│ │
384+
│ │ MiniMax · Moonshot · Venice · Ollama (local) · xAI │ │
385+
│ └─────────────────────────────────────────────────────────┘ │
386+
├──────────────────────────────────────────────────────────────────┤
387+
│ Protocol Layer │
388+
│ ┌──────────────┐ ┌──────────────┐ ┌───────────────────────┐ │
389+
│ │ MCP Protocol │ │ A2A Protocol │ │ AG-UI Protocol │ │
390+
│ │ Client+Server │ │ Bidirectional│ │ SSE + Rich Interactions│ │
391+
│ └──────────────┘ └──────────────┘ └───────────────────────┘ │
392+
├──────────────────────────────────────────────────────────────────┤
393+
│ Integrations │
394+
│ Channels (Discord · Slack · Telegram · Email) · Output Routes │
395+
│ Zapier (7,000+ apps) · Webhooks · Chat Widget · REST API │
396+
├──────────────────────────────────────────────────────────────────┤
397+
│ Observability │
398+
│ OpenTelemetry · Langfuse · Datadog · Jaeger │
399+
├──────────────────────────────────────────────────────────────────┤
400+
│ Your LLM Providers │
401+
│ BYOK — Your Keys, Your Cost │
402+
└──────────────────────────────────────────────────────────────────┘
389403
```
390404

391405
## Tech Stack
@@ -394,13 +408,14 @@ CrewForm uses an **open-core** model: a free Community Edition under AGPL-3.0 an
394408
|-------|-----------|
395409
| **Frontend** | React 18 · TypeScript · Vite · Tailwind CSS · ShadCN UI |
396410
| **State** | TanStack Query · Zustand |
397-
| **Backend** | Supabase (Auth, Database, Realtime, Edge Functions) |
398-
| **Task Runner** | Node.js · Multi-provider LLM integration |
399-
| **Vector Search** | pgvector (team memory + knowledge base RAG) |
400-
| **Protocols** | MCP (Model Context Protocol) · A2A (Agent-to-Agent) · AG-UI (Agent-User Interface) |
401-
| **Integrations** | Zapier · Discord · Slack · Telegram · Email · Webhooks |
411+
| **Backend** | Supabase (Auth, PostgreSQL, Realtime, Edge Functions) |
412+
| **Task Runner** | Node.js · 16 LLM providers + Ollama (local) |
413+
| **Vector Search** | pgvector — hybrid search (cosine + full-text + reranking) |
414+
| **Protocols** | MCP (client + server) · A2A (bidirectional) · AG-UI (SSE + rich interactions) |
415+
| **Observability** | OpenTelemetry · Langfuse · Datadog · Jaeger |
416+
| **Integrations** | Zapier · Discord · Slack · Telegram · Email · Webhooks · Chat Widget |
402417
| **Validation** | Zod |
403-
| **Deployment** | Vercel · Docker |
418+
| **Deployment** | Vercel · Docker Compose |
404419

405420
## Contributing
406421

@@ -453,7 +468,11 @@ Yes! CrewForm supports Docker-based self-hosting. See our [self-hosting guide](h
453468
<details>
454469
<summary><strong>What LLM providers are supported?</strong></summary>
455470

456-
CrewForm supports **16 providers**: OpenAI, Anthropic, Google Gemini, Groq, Mistral, Cohere, NVIDIA NIM, Perplexity, Together, OpenRouter, HuggingFace, MiniMax, Moonshot, Venice, and **Ollama** (local models). More providers can be added via the modular provider architecture.
471+
CrewForm supports **16 cloud providers + Ollama** for local models:
472+
473+
OpenAI, Anthropic, Google Gemini, Groq, Mistral, Cohere, NVIDIA NIM, Perplexity, Together, OpenRouter, HuggingFace, MiniMax, Moonshot, Venice, xAI, and **Ollama** (local — Llama 3, Mistral, Phi, etc.).
474+
475+
Ollama enables fully air-gapped setups — zero API keys, zero data leaving your network. More providers can be added via the modular provider architecture.
457476
</details>
458477

459478
<details>
@@ -470,23 +489,26 @@ CrewForm is a **visual, UI-first platform** — you create agents, teams, and ta
470489

471490
## How CrewForm Compares
472491

473-
| Capability | CrewForm | Most Alternatives |
474-
|---|---|---|
475-
| **Visual UI** | ✅ Drag-and-drop workflow canvas with live execution | Often code-only or basic flow editors |
476-
| **Multi-Agent Teams** | ✅ 3 modes — Pipeline, Orchestrator, Collaboration | Usually single-mode or code-defined |
477-
| **All 3 Agentic Protocols** | ✅ MCP + A2A + AG-UI — native | Typically zero or one |
478-
| **BYOK (zero markup)** | ✅ 16 providers, your keys, your cost | Often limited providers or markup fees |
479-
| **Local Models (Ollama)** | ✅ Native — zero API keys, fully air-gapped | Varies |
480-
| **Self-Hosting** | ✅ One-command Docker Compose | Often cloud-only or complex setup |
481-
| **RAG / Knowledge Base** | ✅ Built-in with pgvector + hybrid search | Sometimes available, often requires plugins |
482-
| **Embeddable Chat Widget** | ✅ One-line script tag, streaming, domain security | Rare — usually requires custom dev |
483-
| **Data Portability** | ✅ JSON export/import for agents and teams | Usually locked to platform |
484-
| **Agent Marketplace** | ✅ Browse, install, and publish templates | Rare in open-source tools |
485-
| **Team Memory** | ✅ pgvector semantic search across runs | Typically not available |
486-
| **Integrations** | ✅ Zapier (7K+ apps), Discord, Slack, Telegram, Trello, webhooks | Usually API-only |
487-
| **Open Source** | ✅ AGPL-3.0 | Varies |
488-
489-
> **CrewForm is the first platform to support all three agentic protocols** (MCP + A2A + AG-UI) — giving your agents access to thousands of tools, cross-framework interop, and real-time UI streaming out of the box.
492+
| Capability | CrewForm | Dify | n8n | CrewAI | LangGraph |
493+
|---|---|---|---|---|---|
494+
| **Visual UI** | ✅ Drag-and-drop canvas + live execution | ✅ Flow editor | ✅ Flow editor | ❌ Code-only | ❌ Code-only |
495+
| **Multi-Agent Teams** | ✅ 3 modes (Pipeline, Orchestrator, Collab) | ❌ Single-agent | ❌ Node-based | ✅ Code-defined | ✅ Code-defined |
496+
| **MCP Protocol** | ✅ Client + Server (bidirectional) | ❌ | ✅ Client only | ❌ | ❌ |
497+
| **A2A Protocol** | ✅ Bidirectional (consume + publish) | ❌ | ❌ | ❌ | ❌ |
498+
| **AG-UI Protocol** | ✅ SSE + rich interactions | ❌ | ❌ | ❌ | ❌ |
499+
| **LLM Providers** | ✅ 16 + Ollama (local) | ~10 | Via nodes | Code | Code |
500+
| **BYOK (zero markup)** | ✅ Your keys, your cost | ✅ | ✅ | ✅ | ✅ |
501+
| **Local Models (Ollama)** | ✅ Native, air-gapped | ✅ | ✅ | ✅ | ✅ |
502+
| **RAG / Knowledge Base** | ✅ Hybrid search + retrieval tester | ✅ | Via nodes | Code | Code |
503+
| **Chat Widget** | ✅ One script tag, streaming | ✅ | ❌ | ❌ | ❌ |
504+
| **Observability** | ✅ OTLP + Langfuse | ✅ LangSmith | ❌ | ✅ | ✅ |
505+
| **Fan-Out (Parallel)** | ✅ Built-in branching + merge | ❌ | ✅ | ❌ | ✅ |
506+
| **Agent Marketplace** | ✅ Browse, install, publish | ✅ Templates | ✅ Templates | ❌ | ❌ |
507+
| **Data Portability** | ✅ JSON export/import | ✅ DSL export | ✅ JSON export | N/A | N/A |
508+
| **Self-Hosting** | ✅ Docker Compose | ✅ Docker | ✅ Docker | N/A (library) | N/A (library) |
509+
| **Open Source** | ✅ AGPL-3.0 | ✅ Apache-2.0 | ✅ Fair-code | ✅ MIT | ✅ MIT |
510+
511+
> **CrewForm is the only platform with all three agentic protocols** (MCP + A2A + AG-UI) — giving your agents access to thousands of tools, cross-framework interop, and real-time UI streaming out of the box.
490512
491513
## License
492514

0 commit comments

Comments
 (0)