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

updated docs

Browse source
This commit is contained in:
arkml 2025-04-09 20:55:26 +05:30
parent 122ee00fac
commit efc6fbcf45
4 changed files with 10 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

7
apps/docs/docs/agents.md
View file

@ -30,10 +30,3 @@ In the agent graph, connected agents refer to children of an agent. An agent can
### Model ### Model
RowBoat currently supports OpenAI LLMs. Agents can be configured to use any of the OpenAI LLMs. RowBoat currently supports OpenAI LLMs. Agents can be configured to use any of the OpenAI LLMs.
### Conversation control after turn
This setting specifies different options for control of conversation after the current agent has put out a user-facing response (i.e., completed the turn). Currently available options are:
1. Retain control for the next turn of conversation (most common and default setting)
2. Give up control to the parent agent (used when the agent has narrow scope such as answering a FAQ)
3. Give up control to the agent designated as Start agent

19
apps/docs/docs/index.md
View file

@ -1,8 +1,8 @@
# Welcome to Rowboat # Welcome to Rowboat
Rowboat is an open-source Cursor like IDE that helps you build, test, and deploy multi-agent AI systems. Rowboat is a low-code AI IDE to build MCP tools connected multi-agent assistants. Rowboat copilot builds the agents for you based on your requirements with the option do everything manually as well.
**Note:** These docs are intended for both developers who would like to self-host our [open-source code](https://github.com/rowboatlabs/rowboat/) as well as users of our [hosted (managed) app](https://app.rowboatlabs.com/). **Note:** These docs are intended for developers who would like to use our [open-source code](https://github.com/rowboatlabs/rowboat/).
- Our source code is on GitHub at [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/) - Our source code is on GitHub at [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/)
- Join us on [discord](https://discord.gg/jHhUKkKHn8) - Join us on [discord](https://discord.gg/jHhUKkKHn8)
@ -12,7 +12,7 @@ Rowboat is an open-source Cursor like IDE that helps you build, test, and deploy
## What is RowBoat? ## What is RowBoat?
**RowBoat is a state-of-art platform to build multi-agent AI systems in a visual interface, with the help of a copilot.** **RowBoat is a state-of-art platform to build multi-agent AI systems in a visual interface, with the help of a copilot.**
RowBoat enables you to build, manage and deploy user-facing assistants. An assistant is made up of multiple agents, each having access to a set of tools and working together to interact with the user as a single assistant. RowBoat enables you to build, manage and deploy user-facing assistants. An assistant is made up of multiple agents, each having access to a set of tools and working together to interact with the user as a single assistant. You can connect any MCP tools to the agents.
For example, you can build a *credit card assistant*, where each agent handles a workflow such as *outstanding payments*, *balance inquiries* and *transaction disputes*. You can equip agents with tools to carry out tasks such as *fetching payment options*, *checking outstanding balance* and *updating user information*. The assistant would help your end-users their credit card-related needs without having to talk to a human agent on your end. For example, you can build a *credit card assistant*, where each agent handles a workflow such as *outstanding payments*, *balance inquiries* and *transaction disputes*. You can equip agents with tools to carry out tasks such as *fetching payment options*, *checking outstanding balance* and *updating user information*. The assistant would help your end-users their credit card-related needs without having to talk to a human agent on your end.
@ -26,7 +26,6 @@ RowBoat Studio lets you create AI agents in minutes, using a visual interface an
| Agent | Handles a specific part of the conversation and<br>performs tasks using tools, based on instructions |• Configurable using plain language instructions<br>• Orchestrate between agents connected as a graph<br>• Can access tools and knowledge sources (RAG)| | Agent | Handles a specific part of the conversation and<br>performs tasks using tools, based on instructions |• Configurable using plain language instructions<br>• Orchestrate between agents connected as a graph<br>• Can access tools and knowledge sources (RAG)|
| Playground | Interactive environment to test assistants<br>conversationally as you build them |• Real-time testing and debugging<br>• Inspect parameters and results of tool calls in-line<br>• Converse with individual agents or the entire assistant| | Playground | Interactive environment to test assistants<br>conversationally as you build them |• Real-time testing and debugging<br>• Inspect parameters and results of tool calls in-line<br>• Converse with individual agents or the entire assistant|
| Copilot | AI-powered concierge that creates and<br>updates agents and tools on your behalf |• Context-aware of all components including playground<br>• Improves agents based on conversations and feedback <br>• Understands your requests in plain language| | Copilot | AI-powered concierge that creates and<br>updates agents and tools on your behalf |• Context-aware of all components including playground<br>• Improves agents based on conversations and feedback <br>• Understands your requests in plain language|
| Simulator | Simulates real-world user interactions<br>with your assistant |• Maintain and run a test-bench of different scenarios<br>• Mock tool responses for quick testing<br>• Reproduce your end-user's experience comprehensively|
### RowBoat Chat API & SDK ### RowBoat Chat API & SDK
- RowBoat Chat API is a stateless HTTP API to interface with the assistant created on RowBoat Studio. You can use the API to drive end-user facing conversations in your app or website. - RowBoat Chat API is a stateless HTTP API to interface with the assistant created on RowBoat Studio. You can use the API to drive end-user facing conversations in your app or website.
@ -37,18 +36,12 @@ RowBoat Studio lets you create AI agents in minutes, using a visual interface an
1. Describe the assistant you are looking to build, to **copilot** 1. Describe the assistant you are looking to build, to **copilot**
2. Review and apply the **agents** (and tools) created by copilot 2. Review and apply the **agents** (and tools) created by copilot
3. Configure **tools** by connecting them to your APIs 3. Configure **MCP servers** and **tools** and connect them to agents
4. Chat with your assistant in the **playground** 4. Chat with your assistant in the **playground**
5. Create and run a test-bench of scenarios in the **simulator** 6. Deploy and use the HTTP API or Python SDK to integrate the agents into your system
6. Deploy the current version to production, with **version control**
**RowBoat SDK:**
1. **Integrate** the SDK into your end-user facing chat application. Use the latest deployed version of your assistant from RowBoat Studio, by specifying your RowBoat API key.
2. Alternatively, **export** your assistant as a JSON artifact from RowBoat Studio and use it to power your custom implementations.
## Why RowBoat? ## Why RowBoat?
Accelerate your path to production-ready multi-agent systems. Rowboat is the fastest way to build and deploy MCP connected multi-agents
1. **Build** complex assistants using plain language and a visual interface 1. **Build** complex assistants using plain language and a visual interface
2. **Integrate** tools and MCP servers in minutes 2. **Integrate** tools and MCP servers in minutes

2
apps/docs/docs/tools.md
View file

@ -3,4 +3,4 @@
- Tools can be defined once in RowBoat Studio and reused across different agents. - Tools can be defined once in RowBoat Studio and reused across different agents.
- RowBoat uses OpenAI style tools with name, description and parameters. - RowBoat uses OpenAI style tools with name, description and parameters.
- For the purposes of quick testing in the Playground, RowBoat Studio can mock tool responses based on tool descriptions. - For the purposes of quick testing in the Playground, RowBoat Studio can mock tool responses based on tool descriptions.
- Developers can easily connect tools to APIs by configuring a Webhook URL in Studio, to which all tool calls will be routed. - Developers can easily connect tools to APIs by configuring MCP servers or Webhook URL in Studio.

7
apps/docs/mkdocs.yml
View file

@ -8,18 +8,12 @@ nav:
- Introduction: index.md - Introduction: index.md
- Open Source License: license.md - Open Source License: license.md
- Getting Started:
- Option 1 - Open Source: oss_installation.md
- Option 2 - Hosted App: hosted_setup.md
- Testing Your Setup: testing.md
- Building in Studio: - Building in Studio:
- Overview: studio_overview.md - Overview: studio_overview.md
- Create agents: create_agents.md - Create agents: create_agents.md
- Test chats in the playground: playground.md - Test chats in the playground: playground.md
- Add tools: add_tools.md - Add tools: add_tools.md
- Update agents: update_agents.md - Update agents: update_agents.md
- Simulate scenarios: simulate.md
- API & SDK: - API & SDK:
- Using the API: using_the_api.md - Using the API: using_the_api.md
@ -30,4 +24,3 @@ nav:
- Graph: graph.md - Graph: graph.md
- Tools: tools.md - Tools: tools.md
- Prompts: prompts.md - Prompts: prompts.md
- Data Sources: data_sources.md