-
Notifications
You must be signed in to change notification settings - Fork 7
docs: rename Starter tools to Unoptimized #721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
04c87de
da38314
f8f7018
3935c62
76d1e08
45ba4c0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,16 @@ | ||
| --- | ||
| title: "Types of Tools" | ||
| description: "Learn about Optimized and Starter tools" | ||
| description: "Learn about Optimized and Unoptimized tools" | ||
| --- | ||
|
|
||
| # Types of Tools | ||
|
|
||
| Arcade offers two types of tools: | ||
|
|
||
| - Starter tools | ||
| - Unoptimized tools | ||
| - Optimized tools | ||
|
|
||
| The distinction is merely a matter of how they are designed. Both types of tools can be used seamlessly in the same way. There is no difference in their interfaces, the way they are called, or how you interact with them through the Arcade [Dashboard](https://api.arcade.dev/dashboard/) or the Arcade [SDK clients](/references). | ||
| The distinction is merely a matter of how Arcade designs them. Both types of tools can be used seamlessly in the same way. No difference exists in their interfaces, the way they are called, or how you interact with them through the Arcade [Dashboard](https://api.arcade.dev/dashboard/) or the Arcade [SDK clients](/references). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This was a vale suggestion, but I think we have some community contributions so this isn't quite true always? Except maybe it is because the Optimized ones are optimized by us?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a good discussion to have now. The community toolkits was an idea where we would show non-arcade toolkits in our docs, kind of like a marketplace. We are not doing that, and with MCP servers, I think we will not do it in the short term, so I'm not sure if it's valid to keep that category.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, cool, then I don't think this suggestion is an issue :) |
||
|
|
||
| Before we understand the two types, let's first understand the background for why we need to differentiate between them. | ||
|
|
||
|
|
@@ -50,14 +50,14 @@ When a user says "Send a DM to John asking about a project update", the LLM can | |
|
|
||
| Optimized tools dramatically improve the speed, reliability and cost-effectiveness of AI Agents and chatbots. | ||
|
|
||
| Since they require careful design and evaluation, Optimized tools take time and effort to build. We understand that your Agent or chatbot project might need capabilities not yet covered by our Optimized MCP Servers. For this reason, we also offer low-level Starter MCP Servers. | ||
| Since they require careful design and evaluation, Optimized tools take time and effort to build. Arcade understands that your Agent or chatbot project might need capabilities not yet covered by Arcade's Optimized MCP Servers. For this reason, Arcade also offers low-level Unoptimized MCP Servers (formerly known as Starter MCP Servers). | ||
|
|
||
| ## Starter tools | ||
| ## Unoptimized tools | ||
|
|
||
| To provide your Agent or chatbot with more freedom to interact with the upstream services, we offer Starter MCP Servers. | ||
| To provide your Agent or chatbot with more freedom to interact with upstream services, we offer Unoptimized MCP Servers. | ||
|
|
||
| Starter tools are heavily influenced by the original API design. Each tool mirrors one HTTP endpoint. | ||
| Unoptimized tools are heavily influenced by the original API design. Each tool mirrors one HTTP endpoint. | ||
|
|
||
| Although we redesign the tool name and argument descriptions to make them more suitable for LLMs, Starter tools are still not optimized for LLM usage. Also, they are not subject to evaluation suites like Optimized tools. For those reasons, we recommend thoroughly evaluating each Starter tool with your Agents or chatbots before using it in production. | ||
| Although we redesign the tool name and argument descriptions to make them more suitable for LLMs, Unoptimized tools are still not optimized for LLM usage. Also, they are not subject to evaluation suites like Optimized tools. For those reasons, we recommend thoroughly evaluating each Unoptimized tool with your Agents or chatbots before using it in production. | ||
|
|
||
| When your Agent's needs are covered by an Optimized tool, we recommend using it instead of a Starter one. Use Starter tools as a complement. Carefully engineer your prompts to ensure your Agent can call them safely. | ||
| When an Optimized tool covers your Agent's needs, we recommend using it instead of an Unoptimized one. Use Unoptimized tools as a complement. Carefully engineer your prompts to ensure your Agent can call them safely. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -276,7 +276,7 @@ t | |
|
|
||
| **Toolkits** | ||
|
|
||
| - `[feature - 🚀]` Introduce [Starter Tools](/guides/create-tools/improve/types-of-tools), a new type of tool that mirrors the original HTTP API design of the upstream service. | ||
| - `[feature - 🚀]` Introduce [Unoptimized tools](/guides/create-tools/improve/types-of-tools), a new type of tool that mirrors the original HTTP API design of the upstream service. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we want to back-edit the changelog...
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Umm, I think it's ok. |
||
| - `[feature - 🚀]` Release Slack started MCP Server which contains support for most of the Slack API. | ||
| - `[feature - 🚀]` Include advanced error handling in the following MCP Servers: Google, Microsoft, Slack, and Asana. Learn more about handling tool errors [here](/guides/create-tools/error-handling/useful-tool-errors). | ||
| - `[bugfix - 🐛]` [MCP Servers/MS Teams] Fix get_chat_metadata by chat's users | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Component name inconsistent with displayed content
Low Severity
The component
StarterToolInfoand filestarter-tool-info.tsxnow display content about "Unoptimized MCP Server" and "Unoptimized tools", creating a naming mismatch. This component is imported across 8+ pages in the codebase. Developers searching for "unoptimized" related code won't find this file. Consider renaming toUnoptimizedToolInfoor similar for consistency.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is acceptable for now. I didn't want to introduce a bigger diff, and we still refer to them in code as starter in some places as well. The "optimized" term is just a user-facing change.