apunkt/rowboat
1
0
Fork 0
mirror of https://github.com/rowboatlabs/rowboat.git synced 2026-04-25 00:16:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixed docs

Browse source
This commit is contained in:
arkml 2025-06-04 10:23:40 +05:30
parent e73d63cd7c
commit d9c58444dc
5 changed files with 30 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

17
apps/docs/docs/add_tools.mdx
View file

@ -5,23 +5,30 @@ Copilot can help you add tools to agents. You can (a) add a mock tool, (b) add a
### Adding mock tools
You can mock any tool you have created by checking the 'Mock tool responses' option.
![Example Tool](img/mock-tool.png)
<Frame caption="Mocking tools">
<img src="img/mock-tool.png" />
</Frame>
### Adding MCP tools
You can add a running MCP server in Settings -> Tools.
![Example Tool](img/add-mcp-server.png)
<Frame caption="Add MCP server">
<img src="img/add-mcp-server.png" />
</Frame>
You can use [supergateway](https://github.com/supercorp-ai/supergateway) to expose any MCP stdio server as an SSE server.
Now, you can import the tools from the MCP server in the Build view.
![Example Tool](img/import-mcp-tools.png)
<Frame caption="Import MCP tools">
<img src="img/import-mcp-tools.png" />
</Frame>
### Debug tool calls in the playground
When agents call tools during a chat in the playground, the tool call parameters and response are available for debugging real-time. For testing purposes, the platform can produce mock tool responses in the playground, without integrating actual tools.
![Mock Tool Responses](img/mock-response.png)
<Frame caption="Mock Tool Responses">
<img src="img/mock-response.png" />
</Frame>

16
apps/docs/docs/hosted_setup.mdx
View file

@ -2,7 +2,7 @@
- This is the developers guide to self-hosting the open-source version of RowBoat.
- Please see our [Introduction](/) page before referring to this guide.
- For direct installation steps, please head to the README of RowBoat's Github repo: [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/). This page provides more context about the installation process and the different components involved.
- For direct installation steps, please head to the README of RowBoat's Github repo: [@rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat/). This page provides more context about the installation process and the different components involved.
## Overview
@ -14,7 +14,7 @@ RowBoat's codebase has three main components:
| **Copilot** | Python framework powering the copilot in RowBoat Studio |
| **RowBoat** | Frontend and backend services to power RowBoat Studio and Chat APIs |
These components are structured as separate services, each containerized with Docker. Running `docker-compose up --build` enables you to use the Studio in your browser, as well as stands up the APIs and SDK.
These components are structured as separate services, each containerized with Docker. Running `docker-compose up --build` enables you to use the Studio in your browser, as well as stands up the APIs and SDK.
## Prerequisites
All of these prerequistes have open-source or free versions.
@ -30,28 +30,28 @@ Refer to our [Github Readme for Prerequisites](https://github.com/rowboatlabs/ro
## Setting up
Refer to our [Github Readme for Local Development](https://github.com/rowboatlabs/rowboat/?tab=readme-ov-file#local-development-setup) to set up Studio, Chat API and SDK via `docker-compose`.
Refer to our [Github Readme for Local Development](https://github.com/rowboatlabs/rowboat/?tab=readme-ov-file#local-development-setup) to set up Studio, Chat API and SDK via `docker-compose`.
### Testing Studio
1. Once you are set up, you should be able to login to the Studio (default local URL: [http://localhost:3000](http://localhost:8000)) via Auth0's login options (Gmail, Github etc.)
<br>
<br/>
2. Once in Studio, create a new blank project or use one of the example templates:
![Create Project](img/project-page.png)
<br>
<br/>
3. Use the copilot to help you build agents:
![Use Copilot](img/use-copilot.png)
<br>
<br/>
4. Ensure that the correct agent is set as the "start agent":
![Set Start Agent](img/start-agent.png)
<br>
<br/>
5. Test out a chat in the playground to verify the agents' behavior:
![Testing Chat](img/testing-chat.png)
<br>
<br/>
### Testing the Chat API

6
apps/docs/docs/index.mdx
View file

@ -23,9 +23,9 @@ RowBoat Studio lets you create AI agents in minutes, using a visual interface an
| Component | Description | Highlights |
|------------|-------------|------------|
| 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|
| 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|
| 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|
| 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|
### RowBoat Chat API & SDK
- [RowBoat Chat API](/using_the_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.

2
apps/docs/docs/studio_overview.mdx
View file

@ -1,5 +1,5 @@
# Building Assistants in Studio
This is a guide to building your first assistant on RowBoat Studio, with examples.<br>
This is a guide to building your first assistant on RowBoat Studio, with examples.<br/>
Prerequisite:

12
apps/docs/docs/testing.mdx
View file

@ -2,26 +2,26 @@
## Testing Studio
1. Once you are set up, you should be able to login to the Studio via Auth0's login options (Gmail, Github etc.).
1. Once you are set up, you should be able to login to the Studio via Auth0's login options (Gmail, Github etc.).
- For the open source installation, the URL for Studio is [http://localhost:3000](http://localhost:3000)
- To use our hosted app, the URL for Studio is [https://app.rowboatlabs.com](https://app.rowboatlabs.com/)
<br>
<br/>
2. Once in Studio, create a new blank project or browse through one of the example projects:
![Create Project](img/project-page.png)
<br>
<br/>
3. Use the copilot to help you build agents:
![Use Copilot](img/use-copilot.png)
<br>
<br/>
4. Ensure that the correct agent is set as the "start agent":
![Set Start Agent](img/start-agent.png)
<br>
<br/>
5. Test out a chat in the playground to verify the agents' behavior:
![Testing Chat](img/testing-chat.png)
<br>
<br/>
### Testing the Chat API