admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/vercel_api/arcade_vercel_api/wrapper_tools/RetrieveProjectBypassRules.json
jottakka 686dfce7b0
[MOAR][VERCEL] Adding Vercel Starter Toolkit (#638) 
Vercel API

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-21 12:06:46 -03:00

337 lines
10 KiB
JSON
Raw Blame History

{
"name": "RetrieveProjectBypassRules",
"fully_qualified_name": "VercelApi.RetrieveProjectBypassRules@0.1.0",
"description": "Retrieve the bypass rules for a specified project.\n\nUse this tool to access the system bypass rules configured for a specific project on Vercel. It is useful for security management and monitoring of firewall settings.",
"toolkit": {
"name": "ArcadeVercelApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "project_id",
"required": true,
"description": "The unique identifier of the project for which to retrieve bypass rules.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "projectId"
},
{
"name": "result_limit",
"required": false,
"description": "The maximum number of rules to retrieve. Specify as a number. This is useful for controlling the volume of data returned.",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "limit"
},
{
"name": "filter_by_source_ip",
"required": false,
"description": "Specify a source IP to filter the system bypass rules for a project.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by source IP"
},
"inferrable": true,
"http_endpoint_parameter_name": "sourceIp"
},
{
"name": "filter_by_domain",
"required": false,
"description": "Specify the domain to filter bypass rules. This filters rules related to the given domain.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by domain"
},
"inferrable": true,
"http_endpoint_parameter_name": "domain"
},
{
"name": "pagination_offset",
"required": false,
"description": "Pagination offset, retrieving results after the specified ID.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Used for pagination. Retrieves results after the provided id"
},
"inferrable": true,
"http_endpoint_parameter_name": "offset"
},
{
"name": "team_identifier",
"required": false,
"description": "The unique identifier of the team on whose behalf the request is performed.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team identifier to perform the request on behalf of."
},
"inferrable": true,
"http_endpoint_parameter_name": "teamId"
},
{
"name": "team_slug",
"required": false,
"description": "The slug representing the team to make the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team slug to perform the request on behalf of."
},
"inferrable": true,
"http_endpoint_parameter_name": "slug"
},
{
"name": "filter_by_project_scope",
"required": false,
"description": "Set to true to filter results by project-scoped rules.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by project scoped rules"
},
"inferrable": true,
"http_endpoint_parameter_name": "projectScope"
}
]
},
"output": {
"description": "Response from the API endpoint 'getBypassIp'.",
"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": "VERCEL_ACCESS_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 vercel API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://api.vercel.com/v1/security/firewall/bypass",
"http_method": "GET",
"headers": {
"Content-Type": "application/json"
},
"parameters": [
{
"name": "projectId",
"tool_parameter_name": "project_id",
"description": "",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "query",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "limit",
"tool_parameter_name": "result_limit",
"description": "",
"value_schema": {
"val_type": "number",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": ""
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "sourceIp",
"tool_parameter_name": "filter_by_source_ip",
"description": "Filter by source IP",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by source IP"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "domain",
"tool_parameter_name": "filter_by_domain",
"description": "Filter by domain",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by domain"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "projectScope",
"tool_parameter_name": "filter_by_project_scope",
"description": "Filter by project scoped rules",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filter by project scoped rules"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "offset",
"tool_parameter_name": "pagination_offset",
"description": "Used for pagination. Retrieves results after the provided id",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Used for pagination. Retrieves results after the provided id"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "teamId",
"tool_parameter_name": "team_identifier",
"description": "The Team identifier to perform the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team identifier to perform the request on behalf of."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "slug",
"tool_parameter_name": "team_slug",
"description": "The Team slug to perform the request on behalf of.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The Team slug to perform the request on behalf of."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "VERCEL_ACCESS_TOKEN",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "",
"is_auth_token": false
}
],
"request_body_spec": null,
"use_request_body_schema_mode": false,
"validate_request_body_schema": false
}
}
Reference in a new issue View git blame Copy permalink