From 3d2665d36c48f4a3bff80136a4c82c332230ee5b Mon Sep 17 00:00:00 2001 From: Eric Gustin <34000337+EricGustin@users.noreply.github.com> Date: Tue, 14 Oct 2025 18:42:27 -0700 Subject: [PATCH] Rename some 'toolkit' references to 'server' (#624) There are many more instances of toolkit within this repo, but the goal of this PR is to get rid of user facing references as much as possible. --------- Co-authored-by: Nate Barbettini --- .vscode/launch.json | 2 +- CONTRIBUTING.md | 2 +- contrib/crewai/README.md | 2 +- contrib/langchain/README.md | 2 +- libs/arcade-cli/README.md | 2 +- libs/arcade-cli/arcade_cli/new.py | 10 +++++----- libs/arcade-core/arcade_core/catalog.py | 8 ++++---- libs/tests/core/test_catalog.py | 2 +- 8 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index e2a769b3..988069c7 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -10,7 +10,7 @@ "console": "integratedTerminal", "jinja": true, "justMyCode": true, - "cwd": "${workspaceFolder}/toolkits/" + "cwd": "${workspaceFolder}" }, { "name": "Debug `arcade login`", diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9f5279d..1f6c45b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,5 +135,5 @@ Before you submit a pull request, check that it meets these guidelines: 2. If the pull request adds functionality, the [docs](https://github.com/ArcadeAI/docs) should be updated. -3. If making contributions to multiple toolkits (i.e. Google and Slack, etc.), submit a separate pull request for each. +3. If making contributions to multiple servers (i.e. Google and Slack, etc.), submit a separate pull request for each. This helps us segregate the changes during the review process making it more efficient. diff --git a/contrib/crewai/README.md b/contrib/crewai/README.md index 9920dc42..de57c280 100644 --- a/contrib/crewai/README.md +++ b/contrib/crewai/README.md @@ -17,7 +17,7 @@

Docs • - Toolkits • + Servers • Python Client • JavaScript Client

diff --git a/contrib/langchain/README.md b/contrib/langchain/README.md index a9752277..a1427b58 100644 --- a/contrib/langchain/README.md +++ b/contrib/langchain/README.md @@ -20,7 +20,7 @@

Arcade Documentation • - Toolkits • + Servers • Python Client • JavaScript Client

diff --git a/libs/arcade-cli/README.md b/libs/arcade-cli/README.md index 308fbbed..24e6270d 100644 --- a/libs/arcade-cli/README.md +++ b/libs/arcade-cli/README.md @@ -10,7 +10,7 @@ Arcade CLI provides a comprehensive command-line interface for the Arcade platfo - **Tool Development**: Create, test, and manage Arcade tools - **Worker Deployment**: Deploy and manage Arcade workers - **Interactive Chat**: Test tools in an interactive environment -- **Project Templates**: Generate new toolkit projects +- **Project Templates**: Generate new server projects ## Installation ```bash diff --git a/libs/arcade-cli/arcade_cli/new.py b/libs/arcade-cli/arcade_cli/new.py index 6da5be90..ef8db64b 100644 --- a/libs/arcade-cli/arcade_cli/new.py +++ b/libs/arcade-cli/arcade_cli/new.py @@ -154,17 +154,17 @@ def create_new_toolkit(output_directory: str, toolkit_name: str) -> None: # Check for illegal characters in the toolkit name if re.match(r"^[a-z0-9_]+$", toolkit_name): if (toolkit_directory / toolkit_name).exists(): - console.print(f"[red]Toolkit '{toolkit_name}' already exists.[/red]") + console.print(f"[red]Server '{toolkit_name}' already exists.[/red]") exit(1) else: console.print( - "[red]Toolkit name contains illegal characters. " + "[red]Server name contains illegal characters. " "Only lowercase alphanumeric characters and underscores are allowed. " "Please try again.[/red]" ) exit(1) - toolkit_description = ask_question("Describe what your toolkit will do (optional)", default="") + toolkit_description = ask_question("Describe what your server will do (optional)", default="") toolkit_author_name = ask_question("Your GitHub username (optional)", default="") while True: toolkit_author_email = ask_question("Your email (optional)", default="") @@ -183,7 +183,7 @@ def create_new_toolkit(output_directory: str, toolkit_name: str) -> None: is_community_toolkit = False if cwd.name == "toolkits" and cwd.parent.name == "arcade-mcp": prompt = ( - "Is your toolkit a community contribution (to be merged into " + "Is your server a community contribution (to be merged into " "\x1b]8;;https://github.com/ArcadeAI/arcade-mcp\x1b\\ArcadeAI/arcade-mcp\x1b]8;;\x1b\\ repo)?" ) is_community_toolkit = ask_yes_no_question(prompt, default=True) @@ -272,7 +272,7 @@ def create_new_toolkit_minimal(output_directory: str, toolkit_name: str) -> None try: create_package(env, template_directory, toolkit_directory, context, ignore_pattern) console.print( - f"[green]Toolkit '{toolkit_name}' created successfully at '{toolkit_directory}'.[/green]" + f"[green]Server '{toolkit_name}' created successfully at '{toolkit_directory}'.[/green]" ) except Exception: remove_toolkit(toolkit_directory, toolkit_name) diff --git a/libs/arcade-core/arcade_core/catalog.py b/libs/arcade-core/arcade_core/catalog.py index d27f14a2..7bf78dd6 100644 --- a/libs/arcade-core/arcade_core/catalog.py +++ b/libs/arcade-core/arcade_core/catalog.py @@ -217,7 +217,7 @@ class ToolCatalog(BaseModel): toolkit_name = toolkit_or_name if not toolkit_name: - raise ValueError("A toolkit name or toolkit must be provided.") + raise ValueError("A server name or server must be provided.") definition = ToolCatalog.create_tool_definition( tool_func, @@ -230,7 +230,7 @@ class ToolCatalog(BaseModel): if fully_qualified_name in self._tools: raise ToolkitLoadError( - f"Tool '{definition.name}' in toolkit '{toolkit_name}' already exists in the catalog." + f"Tool '{definition.name}' in server '{toolkit_name}' already exists in the catalog." ) if str(fully_qualified_name).lower() in self._disabled_tools: @@ -238,7 +238,7 @@ class ToolCatalog(BaseModel): return if str(toolkit_name).lower() in self._disabled_toolkits: - logger.info(f"Toolkit '{toolkit_name!s}' is disabled and will not be cataloged.") + logger.info(f"Server '{toolkit_name!s}' is disabled and will not be cataloged.") return self._tools[fully_qualified_name] = MaterializedTool( @@ -267,7 +267,7 @@ class ToolCatalog(BaseModel): """ if str(toolkit).lower() in self._disabled_toolkits: - logger.info(f"Toolkit '{toolkit.name!s}' is disabled and will not be cataloged.") + logger.info(f"Server '{toolkit.name!s}' is disabled and will not be cataloged.") return for module_name, tool_names in toolkit.tools.items(): diff --git a/libs/tests/core/test_catalog.py b/libs/tests/core/test_catalog.py index 15f16128..7796404e 100644 --- a/libs/tests/core/test_catalog.py +++ b/libs/tests/core/test_catalog.py @@ -512,6 +512,6 @@ def test_add_toolkit_with_duplicate_tool(): catalog.add_toolkit(test_toolkit) # Check that the error message contains the expected substring - assert "Tool 'ValidTool' in toolkit 'test_toolkit' already exists in the catalog." in str( + assert "Tool 'ValidTool' in server 'test_toolkit' already exists in the catalog." in str( exc_info.value )