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 <nate@arcade.dev>
This commit is contained in:
parent
63bc281abc
commit
3d2665d36c
8 changed files with 15 additions and 15 deletions
2
.vscode/launch.json
vendored
2
.vscode/launch.json
vendored
|
|
@ -10,7 +10,7 @@
|
||||||
"console": "integratedTerminal",
|
"console": "integratedTerminal",
|
||||||
"jinja": true,
|
"jinja": true,
|
||||||
"justMyCode": true,
|
"justMyCode": true,
|
||||||
"cwd": "${workspaceFolder}/toolkits/<your_server_name>"
|
"cwd": "${workspaceFolder}"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "Debug `arcade login`",
|
"name": "Debug `arcade login`",
|
||||||
|
|
|
||||||
|
|
@ -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.
|
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.
|
This helps us segregate the changes during the review process making it more efficient.
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://docs.arcade.dev" target="_blank">Docs</a> •
|
<a href="https://docs.arcade.dev" target="_blank">Docs</a> •
|
||||||
<a href="https://docs.arcade.dev/toolkits" target="_blank">Toolkits</a> •
|
<a href="https://docs.arcade.dev/mcp-servers" target="_blank">Servers</a> •
|
||||||
<a href="https://github.com/ArcadeAI/arcade-py" target="_blank">Python Client</a> •
|
<a href="https://github.com/ArcadeAI/arcade-py" target="_blank">Python Client</a> •
|
||||||
<a href="https://github.com/ArcadeAI/arcade-js" target="_blank">JavaScript Client</a>
|
<a href="https://github.com/ArcadeAI/arcade-js" target="_blank">JavaScript Client</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://docs.arcade.dev" target="_blank">Arcade Documentation</a> •
|
<a href="https://docs.arcade.dev" target="_blank">Arcade Documentation</a> •
|
||||||
<a href="https://docs.arcade.dev/toolkits" target="_blank">Toolkits</a> •
|
<a href="https://docs.arcade.dev/mcp-servers" target="_blank">Servers</a> •
|
||||||
<a href="https://github.com/ArcadeAI/arcade-py" target="_blank">Python Client</a> •
|
<a href="https://github.com/ArcadeAI/arcade-py" target="_blank">Python Client</a> •
|
||||||
<a href="https://github.com/ArcadeAI/arcade-js" target="_blank">JavaScript Client</a>
|
<a href="https://github.com/ArcadeAI/arcade-js" target="_blank">JavaScript Client</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ Arcade CLI provides a comprehensive command-line interface for the Arcade platfo
|
||||||
- **Tool Development**: Create, test, and manage Arcade tools
|
- **Tool Development**: Create, test, and manage Arcade tools
|
||||||
- **Worker Deployment**: Deploy and manage Arcade workers
|
- **Worker Deployment**: Deploy and manage Arcade workers
|
||||||
- **Interactive Chat**: Test tools in an interactive environment
|
- **Interactive Chat**: Test tools in an interactive environment
|
||||||
- **Project Templates**: Generate new toolkit projects
|
- **Project Templates**: Generate new server projects
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
```bash
|
```bash
|
||||||
|
|
|
||||||
|
|
@ -154,17 +154,17 @@ def create_new_toolkit(output_directory: str, toolkit_name: str) -> None:
|
||||||
# Check for illegal characters in the toolkit name
|
# Check for illegal characters in the toolkit name
|
||||||
if re.match(r"^[a-z0-9_]+$", toolkit_name):
|
if re.match(r"^[a-z0-9_]+$", toolkit_name):
|
||||||
if (toolkit_directory / toolkit_name).exists():
|
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)
|
exit(1)
|
||||||
else:
|
else:
|
||||||
console.print(
|
console.print(
|
||||||
"[red]Toolkit name contains illegal characters. "
|
"[red]Server name contains illegal characters. "
|
||||||
"Only lowercase alphanumeric characters and underscores are allowed. "
|
"Only lowercase alphanumeric characters and underscores are allowed. "
|
||||||
"Please try again.[/red]"
|
"Please try again.[/red]"
|
||||||
)
|
)
|
||||||
exit(1)
|
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="")
|
toolkit_author_name = ask_question("Your GitHub username (optional)", default="")
|
||||||
while True:
|
while True:
|
||||||
toolkit_author_email = ask_question("Your email (optional)", default="")
|
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
|
is_community_toolkit = False
|
||||||
if cwd.name == "toolkits" and cwd.parent.name == "arcade-mcp":
|
if cwd.name == "toolkits" and cwd.parent.name == "arcade-mcp":
|
||||||
prompt = (
|
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)?"
|
"\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)
|
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:
|
try:
|
||||||
create_package(env, template_directory, toolkit_directory, context, ignore_pattern)
|
create_package(env, template_directory, toolkit_directory, context, ignore_pattern)
|
||||||
console.print(
|
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:
|
except Exception:
|
||||||
remove_toolkit(toolkit_directory, toolkit_name)
|
remove_toolkit(toolkit_directory, toolkit_name)
|
||||||
|
|
|
||||||
|
|
@ -217,7 +217,7 @@ class ToolCatalog(BaseModel):
|
||||||
toolkit_name = toolkit_or_name
|
toolkit_name = toolkit_or_name
|
||||||
|
|
||||||
if not toolkit_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(
|
definition = ToolCatalog.create_tool_definition(
|
||||||
tool_func,
|
tool_func,
|
||||||
|
|
@ -230,7 +230,7 @@ class ToolCatalog(BaseModel):
|
||||||
|
|
||||||
if fully_qualified_name in self._tools:
|
if fully_qualified_name in self._tools:
|
||||||
raise ToolkitLoadError(
|
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:
|
if str(fully_qualified_name).lower() in self._disabled_tools:
|
||||||
|
|
@ -238,7 +238,7 @@ class ToolCatalog(BaseModel):
|
||||||
return
|
return
|
||||||
|
|
||||||
if str(toolkit_name).lower() in self._disabled_toolkits:
|
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
|
return
|
||||||
|
|
||||||
self._tools[fully_qualified_name] = MaterializedTool(
|
self._tools[fully_qualified_name] = MaterializedTool(
|
||||||
|
|
@ -267,7 +267,7 @@ class ToolCatalog(BaseModel):
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if str(toolkit).lower() in self._disabled_toolkits:
|
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
|
return
|
||||||
|
|
||||||
for module_name, tool_names in toolkit.tools.items():
|
for module_name, tool_names in toolkit.tools.items():
|
||||||
|
|
|
||||||
|
|
@ -512,6 +512,6 @@ def test_add_toolkit_with_duplicate_tool():
|
||||||
catalog.add_toolkit(test_toolkit)
|
catalog.add_toolkit(test_toolkit)
|
||||||
|
|
||||||
# Check that the error message contains the expected substring
|
# 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
|
exc_info.value
|
||||||
)
|
)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue