arcade-mcp/toolkits/github_api/arcade_github_api/wrapper_tools/ManageGithubEnvironmentSecret.json
jottakka de742ff4f1
[MOAR][Asana][Github] Adding GitHub and Asana starter toolkits (#663)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-30 18:21:34 -03:00

249 lines
9.7 KiB
JSON

{
"name": "ManageGithubEnvironmentSecret",
"fully_qualified_name": "GithubApi.ManageGithubEnvironmentSecret@0.1.0",
"description": "Create or update an encrypted environment secret on GitHub.\n\nThis tool allows you to create or update an environment secret in a GitHub repository. It requires encryption of the secret value using LibSodium and authentication with a token that has the 'repo' scope. Ideal for automating secret management in deployment environments.",
"toolkit": {
"name": "ArcadeGithubApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "repository_unique_id",
"required": true,
"description": "The unique identifier of the GitHub repository where the secret will be managed.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The unique identifier of the repository."
},
"inferrable": true,
"http_endpoint_parameter_name": "repository_id"
},
{
"name": "environment_name",
"required": true,
"description": "The name of the environment in the GitHub repository where the secret will be created or updated.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the environment."
},
"inferrable": true,
"http_endpoint_parameter_name": "environment_name"
},
{
"name": "secret_name",
"required": true,
"description": "The name of the secret to be created or updated in the GitHub environment.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the secret."
},
"inferrable": true,
"http_endpoint_parameter_name": "secret_name"
},
{
"name": "encrypted_secret_value",
"required": true,
"description": "The secret value encrypted with LibSodium using a public key. Retrieve the key from the 'Get an environment public key' endpoint.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-environment-public-key) endpoint."
},
"inferrable": true,
"http_endpoint_parameter_name": "encrypted_value"
},
{
"name": "encryption_key_id",
"required": true,
"description": "The identifier for the encryption key used to encrypt the secret. This is required to ensure the correct decryption of the secret on GitHub.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of the key you used to encrypt the secret."
},
"inferrable": true,
"http_endpoint_parameter_name": "key_id"
}
]
},
"output": {
"description": "Response from the API endpoint 'actions/create-or-update-environment-secret'.",
"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-github",
"provider_type": "oauth2",
"id": null,
"oauth2": null
},
"secrets": [
{
"key": "GIT_SERVER_URL"
}
],
"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 GitHub API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "{git_server_url}/api/v3/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
"http_method": "PUT",
"headers": {},
"parameters": [
{
"name": "repository_id",
"tool_parameter_name": "repository_unique_id",
"description": "The unique identifier of the repository.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The unique identifier of the repository."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "environment_name",
"tool_parameter_name": "environment_name",
"description": "The name of the environment.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the environment."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "secret_name",
"tool_parameter_name": "secret_name",
"description": "The name of the secret.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The name of the secret."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "encrypted_value",
"tool_parameter_name": "encrypted_secret_value",
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-environment-public-key) endpoint.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-environment-public-key) endpoint."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "key_id",
"tool_parameter_name": "encryption_key_id",
"description": "ID of the key you used to encrypt the secret.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "ID of the key you used to encrypt the secret."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "GIT_SERVER_URL",
"parameter_name": "git_server_url",
"accepted_as": "path",
"formatted_value": null,
"description": "",
"is_auth_token": false
},
{
"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": "{\n \"content\": {\n \"application/json\": {\n \"examples\": {\n \"default\": {\n \"value\": {\n \"encrypted_value\": \"c2VjcmV0\",\n \"key_id\": \"012345678912345678\"\n }\n }\n },\n \"schema\": {\n \"properties\": {\n \"encrypted_value\": {\n \"description\": \"Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-environment-public-key) endpoint.\",\n \"pattern\": \"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$\",\n \"type\": \"string\"\n },\n \"key_id\": {\n \"description\": \"ID of the key you used to encrypt the secret.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"encrypted_value\",\n \"key_id\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}",
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}