apunkt/rowboat
1
0
Fork 0
mirror of https://github.com/rowboatlabs/rowboat.git synced 2026-05-02 20:03:21 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
arkml 2025-04-07 16:13:49 +05:30 • committed by GitHub
parent 537be740e1
commit a106db9a22
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 325 deletions
Download patch file Download diff file Expand all files Collapse all files

341
README.md
View file

@ -1,321 +1,40 @@
![ui](/assets/banner.png)
<h2 align="center">The AI-assisted agent builder</h2>
<h2 align="center">Let AI build multi-agents with MCP for you</h2>
<h5 align="center">
[Quickstart](#quick-start) | [Docs](https://docs.rowboatlabs.com/) | [Website](https://www.rowboatlabs.com/) | [Discord](https://discord.gg/jHhUKkKHn8)
</h5>
A Cursor-like, AI-assisted, no-code IDE for building production-ready multi-agents.
Build multi-agents in minutes with Rowboat:
- ✨ Start from an Idea -> AI plans and builds the multi-agent system for you
- E.g. "Build me an assistant for a food delivery company to handle delivery status and missing items. Include the necessary tools."
- 🌐 Connect MCP servers
- Add the MCP servers in settings -> import the tools into Rowboat.
- 📞 Integrate into your app using the HTTP API
- Grab the project ID and generated API key from settings and use the API.
- ✨ Start from a simple prompt to create fully functional agents with the Copilot
- 🧪 Test them in AI-simulated scenarios
- 🌐 Connect MCP servers and tools
- 📞 Interact through the Python SDK, a web widget, or a Twilio phone number
- ♻️ Continuously refine your agents by providing feedback to the Copilot
Built with OpenAI's Agents SDK, Rowboat is the fastest way to build multi-agents!
## Quick start
Built on OpenAI's Agents SDK, **Rowboat is the fastest way to build multi-agents!**
![ui](/assets/ui_revamp_screenshot.png)
# Quick start
## Prerequisites
Before running Rowboat, ensure you have:
1. **Docker Desktop**
- [Download Docker Desktop](https://www.docker.com/products/docker-desktop)
2. **OpenAI API Key**
- Obtain from your OpenAI account.
- Other platforms: Refer to the [MongoDB documentation](https://www.mongodb.com/docs/manual/installation/) for details.
## Setup Rowboat
1. **Clone the Repository**
1. **Clone the Repository and start Rowboat docker**
```bash
git clone git@github.com:rowboatlabs/rowboat.git
cd rowboat
```
2. **Set OpenAI key**
```bash
export OPENAI_API_KEY=your-openai-api-key
```
3. **Start the App**
```bash
docker-compose up --build
```
4. **Access the App**
- Visit [http://localhost:3000](http://localhost:3000).
![ui](/assets/ui_revamp_screenshot.png)
Refer to [Docs](https://docs.rowboatlabs.com/) to learn how to start building agents with Rowboat.
## Integrate Rowboat to your app with the HTTP API
# Advanced
## 1. Tool Use
You can add your tools / APIs to Rowboat through (a) connecting MCP servers, or (b) connecting a webhook.
### 1.1 MCP Servers
You can intergrate any MCP server in Settings -> Tools -> MCP Servers. The Tools on the servers will show up inside Rowboats Tools section.
<img src="/assets/mcp-import.png" alt="ui" width="400"/>
Tip: You might want to set the MCP url as http://host.docker.internal/... to allow services to access the MCP servers on your localhost.
### 1.2 Webhook
You can point Rowboat to any webhook in Settings -> Tools -> Webhook.
Rowboat also includes a built-in webhook service that allows you to implement custom tool functions easily. To use this feature:
1. **Generate Signing Secret**
Generate a secret for securing webhook requests:
```bash
openssl rand -hex 32
```
2. **Update Environment Variables**
```ini
SIGNING_SECRET=<your-generated-secret>
```
3. **Implement Your Functions**
Add your custom functions to `apps/tools_webhook/function_map.py`:
```python
def get_weather(location: str, units: str = "metric"):
"""Return weather data for the given location."""
# Your implementation here
return {"temperature": 20, "conditions": "sunny"}
def check_inventory(product_id: str):
"""Check inventory levels for a product."""
# Your implementation here
return {"in_stock": 42, "warehouse": "NYC"}
# Add your functions to the map
FUNCTIONS_MAP = {
"get_weather": get_weather,
"check_inventory": check_inventory
}
```
4. **Start the Tools Webhook Service**
```bash
docker compose --profile tools_webhook up -d
```
5. **Register Tools in Rowboat**
- Navigate to your project config at `/projects/<PROJECT_ID>/config`
- Ensure that the webhook URL is set to: `http://tools_webhook:3005/tool_call`
- Tools will automatically be forwarded to your webhook implementation
The webhook service handles all the security and parameter validation, allowing you to focus on implementing your tool logic.
## 2. Retrieve Augmented Generation (RAG)
Rowboat supports adding text directly, document uploads or scraping URLs to enhance the responses with your custom knowledge base. Rowboat uses Qdrant as the vector DB.
### 2.1 Setup Qdrant
To enable RAG you need to first setup Qdrant.
1. Option1: Run Qdrant locally
- Run Qdrant docker
```bash
docker run -p 6333:6333 qdrant/qdrant
```
- Update environment variables
```ini
USE_RAG=true
QDRANT_URL=http://localhost:6333
QDRANT_API_KEY=<your-api-key> # Only needed for Qdrant Cloud
```
2. Option2: Use [Qdrant Cloud](https://cloud.qdrant.io/)
- Note your cluster URL and API key
- Update environment variables
```ini
USE_RAG=true
QDRANT_URL=<your-qdrant-cloud-url>
QDRANT_API_KEY=<your-api-key>
```
3. Initialize Qdrant Collections
```bash
docker compose --profile setup_qdrant up setup_qdrant
```
If you need to delete the collections and start fresh, you can run:
```bash
docker compose --profile delete_qdrant up delete_qdrant
```
### 2.2 Adding Knowledge Base for RAG
You can add a knowledge corpus to Rowboat by directly adding text information, uploading supported files or by pointing Rowboat to URLs for scraping.
#### (a) Create Text for Knowledge
Rowboat support directly creating a corpus of knowledge inside the platform.
- Start the Text Worker
```bash
docker compose --profile rag_text_worker up -d
```
#### (b) Scrape URLs for Knowledge
Rowboat supports scraping urls using Firecrawl. To setup scraping:
1. Get Firecrawl API Key
- Sign up at [Firecrawl](https://firecrawl.co)
- Generate an API key
2. Update Environment Variables
```ini
USE_RAG_SCRAPING=true
FIRECRAWL_API_KEY=<your-firecrawl-api-key>
```
3. Start the URLs Worker
```bash
docker compose --profile rag_urls_worker up -d
```
#### (c) Upload Files for Knowledge
Rowboat supports file uploads (PDF, DOCX, TXT) for your knowledge base. It uses Google's Gemini LLM to convert the documents to Markdown before indexing:
1. Prerequisites
- An AWS S3 bucket for file storage
- Google Cloud API key with Generative Language (Gemini) API enabled (for enhanced document parsing)
2. Configure AWS S3
- Create an S3 bucket
- Add the following CORS configuration to your bucket:
```json
[
{
"AllowedHeaders": [
"*"
],
"AllowedMethods": [
"PUT",
"POST",
"DELETE",
"GET"
],
"AllowedOrigins": [
"http://localhost:3000",
],
"ExposeHeaders": [
"ETag"
]
}
]
```
- Ensure your AWS credentials have the following IAM policy:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:DeleteObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::<your-bucket-name>/*",
"arn:aws:s3:::<your-bucket-name>"
]
}
]
}
```
3. Update Environment Variables
```ini
USE_RAG_UPLOADS=true
AWS_ACCESS_KEY_ID=<your-aws-access-key>
AWS_SECRET_ACCESS_KEY=<your-aws-secret-key>
RAG_UPLOADS_S3_BUCKET=<your-s3-bucket-name>
RAG_UPLOADS_S3_REGION=<your-s3-region>
GOOGLE_API_KEY=<your-google-api-key>
```
4. Start the Files Worker
```bash
docker compose --profile rag_files_worker up -d
```
After enabling RAG and starting the required workers, you can manage your knowledge base through the Rowboat UI at `/projects/<PROJECT_ID>/sources`.
## 3. Chat Widget
Rowboat provides an embeddable chat widget that you can add to any website. To enable and use the chat widget:
1. **Generate JWT Secret**
Generate a secret for securing chat widget sessions:
```bash
openssl rand -hex 32
```
2. **Update Environment Variables**
```ini
USE_CHAT_WIDGET=true
CHAT_WIDGET_SESSION_JWT_SECRET=<your-generated-secret>
```
3. **Start the Chat Widget Service**
```bash
docker compose --profile chat_widget up -d
```
4. **Add Widget to Your Website**
You can find the chat-widget embed code under `/projects/<PROJECT_ID>/config`
After setup, the chat widget will appear on your website and connect to your Rowboat project.
## 4. Interact with Rowboat API
There are two ways to interact with Rowboat's API:
1. **Option 1: Python SDK**
For Python applications, we provide an official SDK for easier integration:
```bash
pip install rowboat
```
```python
from rowboat import Client
client = Client(
host="http://localhost:3000",
project_id="<PROJECT_ID>",
api_key="<API_KEY>" # Generate this from /projects/<PROJECT_ID>/config
)
# Simple chat interaction
messages = [{"role": "user", "content": "Tell me the weather in London"}]
response_messages, state = client.chat(messages=messages)
```
For more details, see the [Python SDK documentation](./apps/python-sdk/README.md).
1. **Option 2: HTTP API**
You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
- Project ID is available in the URL of the project page
- API Key can be generated from the project config page at `/projects/<PROJECT_ID>/config`
@ -358,35 +77,7 @@ There are two ways to interact with Rowboat's API:
}
```
### 5. Authentication
Refer to [Docs](https://docs.rowboatlabs.com/) to learn how to start building agents with Rowboat.
By default, Rowboat runs without authentication. To enable user authentication using Auth0:
1. **Auth0 Setup**
- **Create an Auth0 Account**: Sign up at [Auth0](https://auth0.com).
- **Create a New Application**: Choose "Regular Web Application", select "Next.js" as the application type, and name it "Rowboat".
- **Configure Application**:
- **Allowed Callback URLs**: In the Auth0 Dashboard, go to your "Rowboat" application settings and set `http://localhost:3000/api/auth/callback` as an Allowed Callback URL.
- **Get Credentials**: Collect the following from your Auth0 application settings:
- **Domain**: Copy your Auth0 domain (ensure you append `https://` to the Domain that the Auth0 dashboard shows you)
- **Client ID**: Your application's unique identifier
- **Client Secret**: Your application's secret key
- **Generate secret**: Generate a session encryption secret in your terminal and note the output for later:
```bash
openssl rand -hex 32
```
2. **Update Environment Variables**
Add the following to your `.env` file:
```ini
USE_AUTH=true
AUTH0_SECRET=your-generated-secret # Generated using openssl command
AUTH0_BASE_URL=http://localhost:3000 # Your application's base URL
AUTH0_ISSUER_BASE_URL=https://example.auth0.com # Your Auth0 domain (ensure it is prefixed with https://)
AUTH0_CLIENT_ID=your-client-id
AUTH0_CLIENT_SECRET=your-client-secret
```
After enabling authentication, users will need to sign in to access the application.