arcade-mcp/toolkits/posthog_api/arcade_posthog_api/wrapper_tools/ModifyPersonsInEnvironment.json
jottakka b7bb2c8d03
[MOAR][PostHog] Adding PostHog starter toolkit (+722) (#654)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-27 12:22:18 -03:00

385 lines
12 KiB
JSON

{
"name": "ModifyPersonsInEnvironment",
"fully_qualified_name": "PosthogApi.ModifyPersonsInEnvironment@0.1.0",
"description": "Modify or remove persons in a given environment.\n\nUse this tool to update or delete the information of persons within a specified environment using the project ID and person ID. For creating or further updating, the capture API or SDKs are recommended.",
"toolkit": {
"name": "ArcadePosthogApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "project_id_of_target_environment",
"required": true,
"description": "The Project ID for the environment you want to access. Find it with a call to /api/projects/.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
"inferrable": true,
"http_endpoint_parameter_name": "project_id"
},
{
"name": "response_format",
"required": false,
"description": "Specifies the format of the response data. Acceptable values are 'csv' or 'json'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"csv",
"json"
],
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "format"
},
{
"name": "person_identifier",
"required": false,
"description": "A unique integer used to identify the person for modification or deletion.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "person_id",
"required": false,
"description": "The unique identifier for the person you want to update or delete. This is an integer value.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "id"
},
{
"name": "person_name",
"required": false,
"description": "The name of the person to modify. This is required for updating the person's information.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "name"
},
{
"name": "distinct_ids_list",
"required": false,
"description": "List of unique identifiers for individuals to be updated or deleted. Each identifier should be a string.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "distinct_ids"
},
{
"name": "person_properties",
"required": false,
"description": "JSON string of properties and values to update for a person. This may include attributes like name, email, etc.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "properties"
},
{
"name": "person_created_at",
"required": false,
"description": "The timestamp of when the person was created, formatted as a string. This helps identify the creation date of the person within the system.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "created_at"
},
{
"name": "person_identifier_uuid",
"required": false,
"description": "The unique identifier for the person whose data is to be updated or deleted. This UUID is required for the operation.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "uuid"
}
]
},
"output": {
"description": "Response from the API endpoint 'environments_persons_partial_update'.",
"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": "POSTHOG_SERVER_URL"
},
{
"key": "POSTHOG_PERSONAL_API_KEY"
}
],
"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 Datadog API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "{posthog_server_url}/api/environments/{project_id}/persons/{id}/",
"http_method": "PATCH",
"headers": {},
"parameters": [
{
"name": "format",
"tool_parameter_name": "response_format",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"csv",
"json"
],
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "id",
"tool_parameter_name": "person_id",
"description": "A unique integer value identifying this person.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique integer value identifying this person."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "project_id",
"tool_parameter_name": "project_id_of_target_environment",
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "id",
"tool_parameter_name": "person_id",
"description": "",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "name",
"tool_parameter_name": "person_name",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "distinct_ids",
"tool_parameter_name": "distinct_ids_list",
"description": "",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "properties",
"tool_parameter_name": "person_properties",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "created_at",
"tool_parameter_name": "person_created_at",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "uuid",
"tool_parameter_name": "person_identifier_uuid",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "POSTHOG_SERVER_URL",
"parameter_name": "posthog_server_url",
"accepted_as": "path",
"formatted_value": null,
"description": "",
"is_auth_token": false
},
{
"arcade_key": "POSTHOG_PERSONAL_API_KEY",
"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 \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"distinct_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"readOnly\": true\n },\n \"properties\": {},\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true\n },\n \"uuid\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"readOnly\": true\n }\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}