mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-04-25 00:16:29 +02:00
update docs with new images and videos
This commit is contained in:
parent
4987034739
commit
c338ec4dec
11 changed files with 20 additions and 35 deletions
|
|
@ -1,19 +1,19 @@
|
|||
## Add tools to agents
|
||||
Copilot can help you add tools to agents.
|
||||
Copilot can help you add tools to agents. You can (a) add a mock tool, (b) add a tool from an MCP server, (c) integrate with you own tools using a webhook.
|
||||
|
||||
### Instruct copilot to add tools
|
||||

|
||||
|
||||

|
||||
### Adding mock tools
|
||||
You can mock any tool you have created by checking the 'Mock tool responses' option.
|
||||
|
||||
### Inspect tools and agents
|
||||
Note how copilot not only creates the tool definitions for you, but also updates the relevant agent instructions to use the tool and connects the tool to the agent.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### Adding MCP tools
|
||||
|
||||
[](https://www.youtube.com/watch?v=EbkIPCTyD58)
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||

|
||||

|
||||

|
||||
|
|
@ -19,14 +19,11 @@ The agent uses examples as a reference for behavior in different scenarios. Whil
|
|||
### Prompts
|
||||
Prompts attached to an agent will be used by the agent in addition to instructions.
|
||||
|
||||
### RAG
|
||||
Data sources added to an agent will be used as knowledge, retrieved using embedding match in a typical RAG fashion. Advanced configurations allow for setting number of matches, etc. RAG is currently implemented as a predefined tool call which the agent will use when it determines that it needs to retrieve knowledge. This behavior can be further fine-tuned by specifying corresponding instructions or prompts.
|
||||
|
||||
### Tools
|
||||
Tools attached to an agent will be put out as tool calls. The behavior of when to invoke tools can be fine-tuned by specifying corresponding instructions or prompts. Adding examples to agents can also be useful in controlling tool call behavior.
|
||||
|
||||
### Connected Agents
|
||||
In the agent graph, connected agents refer to children of an agent. An agent can choose to transfer control of the conversation to one of its children, by using internal tool calls (need not be configured separately). Similar to tools, the behavior of when to transfer the chat to a child agent can be fine-tuned by specifying corresponding instructions, examples and prompts.
|
||||
In the agent instructions, the connected agents are shown with an '@mention'. If the agent mentioned in an instruction (connected agent) does not actually exist, the connected agent's name would show up with an '!' to call to attention.
|
||||
|
||||
### 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 GPT-4o or GPT-4o-mini.
|
||||
|
|
@ -4,20 +4,17 @@ Copilot can set up agents for you from scratch.
|
|||
### Instruct copilot
|
||||
First, tell it about the initial set of agents that make up your assistant.
|
||||
|
||||

|
||||
[](https://www.youtube.com/watch?v=3t2Fpn6Vyds)
|
||||
|
||||
Using copilot to create your initial set of agents helps you leverage best practices in formatting agent instructions and connecting agents to each other as a graph, all of which have been baked into copilot.
|
||||
|
||||
### Inspect the agents
|
||||
Once you apply changes, inspect the agents to see how copilot has built them. Specifically, note the Instructions, Examples and Connected Agents in each agent.
|
||||
Once you apply changes, inspect the agents to see how copilot has built them. Specifically, note the Instructions, and Examples in each agent.
|
||||
|
||||

|
||||

|
||||
|
||||
Also notice that copilot would likely have created a "Hub" agent that is "connected" to other agents.
|
||||
|
||||

|
||||
|
||||
### Make changes if needed
|
||||
Tweak the instructions and examples manually if needed.
|
||||
Tweak the instructions and examples through the copilot, or generate instructions button, or by manually editing it.
|
||||
|
||||

|
||||
[](https://www.youtube.com/watch?v=uoCEQtOe7eE)
|
||||
BIN
apps/docs/docs/img/agent-instruction.png
Normal file
BIN
apps/docs/docs/img/agent-instruction.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 152 KiB |
BIN
apps/docs/docs/img/chat-delivery.png
Normal file
BIN
apps/docs/docs/img/chat-delivery.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 114 KiB |
BIN
apps/docs/docs/img/mock-response.png
Normal file
BIN
apps/docs/docs/img/mock-response.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 135 KiB |
BIN
apps/docs/docs/img/mock-tool.png
Normal file
BIN
apps/docs/docs/img/mock-tool.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
|
|
@ -4,12 +4,4 @@
|
|||
|
||||
The playground is intended to test out the assistant as you build it. The User and Assistant messages represent the conversation that your end-user will have if your assistant is deployed in production. The playground also has debug elements which show the flow of control between different agents in your system, as well as which agent finally responded to the user.
|
||||
|
||||

|
||||
|
||||
In the playground, you can also set initial context at start of chat, that will be passed to all agents. This is typically used for providing user identity information such as user ID, login email, etc.
|
||||

|
||||
|
||||
### Ask copilot questions
|
||||
You can ask copilot clarifications about the chat, such as why the agents responded a certain way or why an agent was invoked.
|
||||
|
||||

|
||||

|
||||
|
|
@ -3,4 +3,4 @@
|
|||
- Tools can be defined once in RowBoat Studio and reused across different agents.
|
||||
- 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.
|
||||
- Developers can easily connect tools to APIs by configuring MCP servers or Webhook URL in Studio.
|
||||
- Developers can easily connect tools to APIs by configuring MCP servers or Webhook URL in Settings.
|
||||
|
|
@ -20,6 +20,5 @@ nav:
|
|||
|
||||
- Concepts:
|
||||
- Agents: agents.md
|
||||
- Graph: graph.md
|
||||
- Tools: tools.md
|
||||
- Prompts: prompts.md
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue