arcade-mcp/toolkits/weaviate_api/arcade_weaviate_api/wrapper_tools/CreateAliasMapping.json

{
  "name": "CreateAliasMapping",
  "fully_qualified_name": "WeaviateApi.CreateAliasMapping@0.1.0",
  "description": "Create a new alias for a collection in Weaviate.\n\nThis tool creates a new alias mapping between an alias name and a collection (class) in Weaviate. Use it to set up alternative names for accessing collections.",
  "toolkit": {
    "name": "ArcadeWeaviateApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "alias_name",
        "required": false,
        "description": "The unique name of the alias, serving as an alternative identifier for the specified collection.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The unique name of the alias that serves as an alternative identifier for the collection."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "alias"
      },
      {
        "name": "collection_class_name",
        "required": false,
        "description": "The name of the collection (class) to which the alias is mapped.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The name of the collection (class) to which this alias is mapped."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "class"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'aliases.create'.",
    "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": "WEAVIATE_API_KEY"
      },
      {
        "key": "WEAVIATE_SERVER_URL"
      }
    ],
    "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 weaviate API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "{weaviate_server_url}/v1/aliases",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "alias",
        "tool_parameter_name": "alias_name",
        "description": "The unique name of the alias that serves as an alternative identifier for the collection.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The unique name of the alias that serves as an alternative identifier for the collection."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "class",
        "tool_parameter_name": "collection_class_name",
        "description": "The name of the collection (class) to which this alias is mapped.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The name of the collection (class) to which this alias is mapped."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "WEAVIATE_API_KEY",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "",
        "is_auth_token": false
      },
      {
        "arcade_key": "WEAVIATE_SERVER_URL",
        "parameter_name": "weaviate_server_url",
        "accepted_as": "path",
        "formatted_value": null,
        "description": "",
        "is_auth_token": false
      }
    ],
    "request_body_spec": "{\n  \"content\": {\n    \"application/yaml\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"alias\": {\n            \"type\": \"string\",\n            \"description\": \"The unique name of the alias that serves as an alternative identifier for the collection.\"\n          },\n          \"class\": {\n            \"type\": \"string\",\n            \"description\": \"The name of the collection (class) to which this alias is mapped.\"\n          }\n        },\n        \"description\": \"Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection.\"\n      }\n    },\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"alias\": {\n            \"type\": \"string\",\n            \"description\": \"The unique name of the alias that serves as an alternative identifier for the collection.\"\n          },\n          \"class\": {\n            \"type\": \"string\",\n            \"description\": \"The name of the collection (class) to which this alias is mapped.\"\n          }\n        },\n        \"description\": \"Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection.\"\n      }\n    }\n  },\n  \"required\": true\n}",
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}