arcade-mcp/toolkits/vercel_api/arcade_vercel_api/wrapper_tools/RetrieveVercelAlias.json
jottakka 686dfce7b0
[MOAR][VERCEL] Adding Vercel Starter Toolkit (#638)
Vercel API

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-21 12:06:46 -03:00

304 lines
9.6 KiB
JSON

{
"name": "RetrieveVercelAlias",
"fully_qualified_name": "VercelApi.RetrieveVercelAlias@0.1.0",
"description": "Retrieve Vercel alias information for a host name or alias ID.\n\nUse this tool to fetch alias details for a specified host name or alias ID on Vercel.",
"toolkit": {
"name": "ArcadeVercelApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "alias_identifier",
"required": true,
"description": "The alias or alias ID of the Vercel entity to retrieve.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The alias or alias ID to be retrieved"
},
"inferrable": true,
"http_endpoint_parameter_name": "idOrAlias"
},
{
"name": "created_after_timestamp",
"required": false,
"description": "Retrieve the alias only if it was created after the specified timestamp (in milliseconds).",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created after the provided timestamp"
},
"inferrable": true,
"http_endpoint_parameter_name": "from"
},
{
"name": "project_id",
"required": false,
"description": "Fetch the alias only if it is associated with this project ID in Vercel.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it is assigned to the provided project ID"
},
"inferrable": true,
"http_endpoint_parameter_name": "projectId"
},
{
"name": "after_timestamp",
"required": false,
"description": "Get the alias only if it was created after this JavaScript timestamp (milliseconds since epoch).",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created after this JavaScript timestamp"
},
"inferrable": true,
"http_endpoint_parameter_name": "since"
},
{
"name": "created_before_timestamp",
"required": false,
"description": "Retrieve the alias only if it was created before this JavaScript timestamp.",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created before this JavaScript timestamp"
},
"inferrable": true,
"http_endpoint_parameter_name": "until"
},
{
"name": "team_identifier",
"required": false,
"description": "The Team identifier to perform the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team identifier to perform the request on behalf of."
},
"inferrable": true,
"http_endpoint_parameter_name": "teamId"
},
{
"name": "team_slug",
"required": false,
"description": "The Team slug to perform the request on behalf of. This specifies the team context for the alias retrieval.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team slug to perform the request on behalf of."
},
"inferrable": true,
"http_endpoint_parameter_name": "slug"
}
]
},
"output": {
"description": "Response from the API endpoint 'getAlias'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": null,
"secrets": [
{
"key": "VERCEL_ACCESS_TOKEN"
}
],
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the vercel API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://api.vercel.com/v4/aliases/{idOrAlias}",
"http_method": "GET",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "from",
"tool_parameter_name": "created_after_timestamp",
"description": "Get the alias only if it was created after the provided timestamp",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created after the provided timestamp"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "projectId",
"tool_parameter_name": "project_id",
"description": "Get the alias only if it is assigned to the provided project ID",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it is assigned to the provided project ID"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "since",
"tool_parameter_name": "after_timestamp",
"description": "Get the alias only if it was created after this JavaScript timestamp",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created after this JavaScript timestamp"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "until",
"tool_parameter_name": "created_before_timestamp",
"description": "Get the alias only if it was created before this JavaScript timestamp",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Get the alias only if it was created before this JavaScript timestamp"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "teamId",
"tool_parameter_name": "team_identifier",
"description": "The Team identifier to perform the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team identifier to perform the request on behalf of."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "slug",
"tool_parameter_name": "team_slug",
"description": "The Team slug to perform the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team slug to perform the request on behalf of."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "idOrAlias",
"tool_parameter_name": "alias_identifier",
"description": "The alias or alias ID to be retrieved",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The alias or alias ID to be retrieved"
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "VERCEL_ACCESS_TOKEN",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "",
"is_auth_token": false
}
],
"request_body_spec": null,
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}