diff --git a/apps/docs/docs/add_tools.mdx b/apps/docs/docs/add_tools.mdx index f88ce710..00a0d0e4 100644 --- a/apps/docs/docs/add_tools.mdx +++ b/apps/docs/docs/add_tools.mdx @@ -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) + + + ### Adding MCP tools You can add a running MCP server in Settings -> Tools. -![Example Tool](img/add-mcp-server.png) + + + 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) + + + ### 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) \ No newline at end of file + + + \ No newline at end of file diff --git a/apps/docs/docs/hosted_setup.mdx b/apps/docs/docs/hosted_setup.mdx index 27f9eabe..ef9d6000 100644 --- a/apps/docs/docs/hosted_setup.mdx +++ b/apps/docs/docs/hosted_setup.mdx @@ -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.) -
+
2. Once in Studio, create a new blank project or use one of the example templates: ![Create Project](img/project-page.png) -
+
3. Use the copilot to help you build agents: ![Use Copilot](img/use-copilot.png) -
+
4. Ensure that the correct agent is set as the "start agent": ![Set Start Agent](img/start-agent.png) -
+
5. Test out a chat in the playground to verify the agents' behavior: ![Testing Chat](img/testing-chat.png) -
+
### Testing the Chat API diff --git a/apps/docs/docs/index.mdx b/apps/docs/docs/index.mdx index 89626228..0d225012 100644 --- a/apps/docs/docs/index.mdx +++ b/apps/docs/docs/index.mdx @@ -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
performs tasks using tools, based on instructions |• Configurable using plain language instructions
• Orchestrate between agents connected as a graph
• Can access tools and knowledge sources (RAG)| -| Playground | Interactive environment to test assistants
conversationally as you build them |• Real-time testing and debugging
• Inspect parameters and results of tool calls in-line
• Converse with individual agents or the entire assistant| -| Copilot | AI-powered concierge that creates and
updates agents and tools on your behalf |• Context-aware of all components including playground
• Improves agents based on conversations and feedback
• Understands your requests in plain language| +| Agent | Handles a specific part of the conversation and
performs tasks using tools, based on instructions |• Configurable using plain language instructions
• Orchestrate between agents connected as a graph
• Can access tools and knowledge sources (RAG)| +| Playground | Interactive environment to test assistants
conversationally as you build them |• Real-time testing and debugging
• Inspect parameters and results of tool calls in-line
• Converse with individual agents or the entire assistant| +| Copilot | AI-powered concierge that creates and
updates agents and tools on your behalf |• Context-aware of all components including playground
• Improves agents based on conversations and feedback
• 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. diff --git a/apps/docs/docs/studio_overview.mdx b/apps/docs/docs/studio_overview.mdx index 89ac4e85..959de2a5 100644 --- a/apps/docs/docs/studio_overview.mdx +++ b/apps/docs/docs/studio_overview.mdx @@ -1,5 +1,5 @@ # Building Assistants in Studio -This is a guide to building your first assistant on RowBoat Studio, with examples.
+This is a guide to building your first assistant on RowBoat Studio, with examples.
Prerequisite: diff --git a/apps/docs/docs/testing.mdx b/apps/docs/docs/testing.mdx index 86df88be..17725009 100644 --- a/apps/docs/docs/testing.mdx +++ b/apps/docs/docs/testing.mdx @@ -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/) -
+
2. Once in Studio, create a new blank project or browse through one of the example projects: ![Create Project](img/project-page.png) -
+
3. Use the copilot to help you build agents: ![Use Copilot](img/use-copilot.png) -
+
4. Ensure that the correct agent is set as the "start agent": ![Set Start Agent](img/start-agent.png) -
+
5. Test out a chat in the playground to verify the agents' behavior: ![Testing Chat](img/testing-chat.png) -
+
### Testing the Chat API