admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/GetLocationCustomAttribute.json
jottakka b89ba3372c
[MOAR][SquareUP] Adding square up toolkit (#596) 
Adding square up toolkit

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-10 17:03:56 -03:00

201 lines
8.8 KiB
JSON
Raw Blame History

{
"name": "GetLocationCustomAttribute",
"fully_qualified_name": "SquareupApi.GetLocationCustomAttribute@0.1.0",
"description": "Retrieve a custom attribute for a specified location.\n\nThis tool fetches a custom attribute associated with a specific location. Optional retrieval of the custom attribute's definition is available. Visibility settings must permit access if owned by another application.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "location_id",
"required": true,
"description": "The ID of the location for which the custom attribute is being retrieved. This is required to identify the specific location in the Square account.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the target [location](entity:Location)."
},
"inferrable": true,
"http_endpoint_parameter_name": "location_id"
},
{
"name": "custom_attribute_key",
"required": true,
"description": "The key of the custom attribute to retrieve. Must match a custom attribute definition key in the Square seller account. Use the qualified key if not the definition owner.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
},
"inferrable": true,
"http_endpoint_parameter_name": "key"
},
{
"name": "custom_attribute_version",
"required": false,
"description": "Specify the version of the custom attribute for consistent reads. If a higher version exists, it is returned. If higher than the current version, an error occurs.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
},
"inferrable": true,
"http_endpoint_parameter_name": "version"
},
{
"name": "include_definition",
"required": false,
"description": "Set to true to include the custom attribute's definition, providing name, description, and data type.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
},
"inferrable": true,
"http_endpoint_parameter_name": "with_definition"
}
]
},
"output": {
"description": "Response from the API endpoint 'RetrieveLocationCustomAttribute'.",
"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": {
"provider_id": "arcade-squareup",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"MERCHANT_PROFILE_READ"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.0.0",
"description": "Tools that enable LLMs to interact directly with the squareup API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.0.0",
"description": ""
},
"url": "https://connect.squareup.com/v2/locations/{location_id}/custom-attributes/{key}",
"http_method": "GET",
"headers": {},
"parameters": [
{
"name": "with_definition",
"tool_parameter_name": "include_definition",
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of\nthe custom attribute. Set this parameter to `true` to get the name and description of the custom\nattribute, information about the data type, or other definition details. The default value is `false`."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "version",
"tool_parameter_name": "custom_attribute_version",
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The current version of the custom attribute, which is used for strongly consistent reads to\nguarantee that you receive the most up-to-date data. When included in the request, Square\nreturns the specified version or a higher version if one exists. If the specified version is\nhigher than the current version, Square returns a `BAD_REQUEST` error."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "location_id",
"tool_parameter_name": "location_id",
"description": "The ID of the target [location](entity:Location).",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the target [location](entity:Location)."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"documentation_urls": []
},
{
"name": "key",
"tool_parameter_name": "custom_attribute_key",
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The key of the custom attribute to retrieve. This key must match the `key` of a custom\nattribute definition in the Square seller account. If the requesting application is not the\ndefinition owner, you must use the qualified key."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
]
}
}
Reference in a new issue View git blame Copy permalink