arcade-mcp/toolkits/miro_api/arcade_miro_api/wrapper_tools/RetrieveBoardItems.json

{
  "name": "RetrieveBoardItems",
  "fully_qualified_name": "MiroApi.RetrieveBoardItems@0.1.0",
  "description": "Retrieve a list of items from a specific Miro board.\n\nThis tool retrieves a list of items for a specific board in Miro. It supports filtering to get all items, child items within a parent, or specific item types. Results are paginated using a cursor-based approach. Suitable for tasks requiring retrieval of board contents.",
  "toolkit": {
    "name": "ArcadeMiroApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "board_identifier",
        "required": true,
        "description": "Unique identifier for the Miro board to retrieve items from.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier (ID) of the board for which you want to retrieve the list of available items."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "board_id"
      },
      {
        "name": "limit_number_of_items",
        "required": false,
        "description": "Sets the maximum number of items to retrieve per API call. Useful for pagination and managing large datasets.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "limit"
      },
      {
        "name": "item_type_filter",
        "required": false,
        "description": "Specify the type of items to retrieve from the board, such as text, shape, or image.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "text",
            "shape",
            "sticky_note",
            "image",
            "document",
            "card",
            "app_card",
            "preview",
            "frame",
            "embed"
          ],
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "type"
      },
      {
        "name": "pagination_cursor",
        "required": false,
        "description": "The cursor value from a previous response to retrieve the next set of items.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "cursor"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'get-items'.",
    "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-miro",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "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 miro API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.0.0",
      "description": ""
    },
    "url": "https://api.miro.com/v2/boards/{board_id}/items",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "limit",
        "tool_parameter_name": "limit_number_of_items",
        "description": "",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "type",
        "tool_parameter_name": "item_type_filter",
        "description": "",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "text",
            "shape",
            "sticky_note",
            "image",
            "document",
            "card",
            "app_card",
            "preview",
            "frame",
            "embed"
          ],
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "cursor",
        "tool_parameter_name": "pagination_cursor",
        "description": "",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": ""
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "documentation_urls": []
      },
      {
        "name": "board_id",
        "tool_parameter_name": "board_identifier",
        "description": "Unique identifier (ID) of the board for which you want to retrieve the list of available items.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier (ID) of the board for which you want to retrieve the list of available items."
        },
        "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
      }
    ]
  }
}