210 lines
7.3 KiB
JSON
210 lines
7.3 KiB
JSON
{
|
|
"name": "GetTeamComponents",
|
|
"fully_qualified_name": "FigmaApi.GetTeamComponents@0.1.0",
|
|
"description": "Retrieve published components from a team's Figma library.\n\nUse this tool to get a list of components that have been published within a specified team's library in Figma.",
|
|
"toolkit": {
|
|
"name": "ArcadeFigmaApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "team_id",
|
|
"required": true,
|
|
"description": "The unique identifier of the team whose components you want to retrieve. This ID is necessary to specify the source team library in Figma.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Id of the team to list components from."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "team_id"
|
|
},
|
|
{
|
|
"name": "number_of_items_per_page",
|
|
"required": false,
|
|
"description": "Specify the number of components to return in one page. Defaults to 30, maximum is 1000.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Number of items to return in a paged list of results. Defaults to 30. Maximum of 1000."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "page_size"
|
|
},
|
|
{
|
|
"name": "cursor_after_id",
|
|
"required": false,
|
|
"description": "Cursor indicating which ID to start retrieving components after. Cannot be used with 'before'.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Cursor indicating which id after which to start retrieving components for. Exclusive with before. The cursor value is an internally tracked integer that doesn't correspond to any Ids."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "after"
|
|
},
|
|
{
|
|
"name": "cursor_before",
|
|
"required": false,
|
|
"description": "Cursor to retrieve components starting before a specific id. Exclusive with 'cursor_after'.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Cursor indicating which id before which to start retrieving components for. Exclusive with after. The cursor value is an internally tracked integer that doesn't correspond to any Ids."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "before"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'getTeamComponents'.",
|
|
"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-figma",
|
|
"provider_type": "oauth2",
|
|
"id": null,
|
|
"oauth2": {
|
|
"scopes": [
|
|
"team_library_content: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 figma API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.1.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://api.figma.com/v1/teams/{team_id}/components",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"Content-Type": "application/json"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "page_size",
|
|
"tool_parameter_name": "number_of_items_per_page",
|
|
"description": "Number of items to return in a paged list of results. Defaults to 30. Maximum of 1000.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Number of items to return in a paged list of results. Defaults to 30. Maximum of 1000."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": 30,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "after",
|
|
"tool_parameter_name": "cursor_after_id",
|
|
"description": "Cursor indicating which id after which to start retrieving components for. Exclusive with before. The cursor value is an internally tracked integer that doesn't correspond to any Ids.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Cursor indicating which id after which to start retrieving components for. Exclusive with before. The cursor value is an internally tracked integer that doesn't correspond to any Ids."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "before",
|
|
"tool_parameter_name": "cursor_before",
|
|
"description": "Cursor indicating which id before which to start retrieving components for. Exclusive with after. The cursor value is an internally tracked integer that doesn't correspond to any Ids.",
|
|
"value_schema": {
|
|
"val_type": "number",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Cursor indicating which id before which to start retrieving components for. Exclusive with after. The cursor value is an internally tracked integer that doesn't correspond to any Ids."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "team_id",
|
|
"tool_parameter_name": "team_id",
|
|
"description": "Id of the team to list components from.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Id of the team to list components from."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"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
|
|
}
|
|
],
|
|
"request_body_spec": null,
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|