arcade-mcp/toolkits/pylon_api/pylon_api/wrapper_tools/CreateNewCollection.json
jottakka 0247c2561b
[MOAR][Pylon] Pylon Starter Toolkit (#658)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-28 15:17:11 -03:00

203 lines
7.3 KiB
JSON

{
"name": "CreateNewCollection",
"fully_qualified_name": "PylonApi.CreateNewCollection@0.1.0",
"description": "Create a new collection in a knowledge base.\n\nThis tool is used to create a new collection within a specified knowledge base by providing the knowledge base ID.",
"toolkit": {
"name": "PylonApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "knowledge_base_id",
"required": true,
"description": "The unique identifier for the knowledge base where the new collection will be created.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the knowledge base the article is being added to."
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "collection_details",
"required": false,
"description": "JSON object containing 'title', 'description', 'slug', and 'parent_collection_id' for the new collection.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the collection."
},
"parent_collection_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The id of the collection associated to the article"
},
"slug": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The slug of the collection. Defaults to a slug based on the title."
},
"title": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The title of the collection."
}
},
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'CreateCollection'.",
"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": "PYLON_SECRET_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 pylon API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://api.usepylon.com/knowledge-bases/{id}/collections",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "id",
"tool_parameter_name": "knowledge_base_id",
"description": "The ID of the knowledge base the article is being added to.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the knowledge base the article is being added to."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "collection_details",
"description": "",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the collection."
},
"parent_collection_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The id of the collection associated to the article"
},
"slug": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The slug of the collection. Defaults to a slug based on the title."
},
"title": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The title of the collection."
}
},
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "PYLON_SECRET_TOKEN",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "",
"is_auth_token": false
}
],
"request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"properties\": {\n \"description\": {\n \"description\": \"Description of the collection.\",\n \"type\": \"string\",\n \"x-go-name\": \"Description\"\n },\n \"parent_collection_id\": {\n \"description\": \"The id of the collection associated to the article\",\n \"type\": \"string\",\n \"x-go-name\": \"ParentCollectionID\"\n },\n \"slug\": {\n \"description\": \"The slug of the collection. Defaults to a slug based on the title.\",\n \"type\": \"string\",\n \"x-go-name\": \"Slug\"\n },\n \"title\": {\n \"description\": \"The title of the collection.\",\n \"type\": \"string\",\n \"x-go-name\": \"Title\"\n }\n },\n \"required\": [\n \"title\"\n ],\n \"type\": \"object\",\n \"x-go-package\": \"pylon/api/apiserver/endpoints\"\n }\n }\n },\n \"required\": false\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}