Tools reference — all 180 tools
Generated from the live MCP tool registry by
scripts/gen_mcp_tools_reference.py— do not hand-edit. Re-run after changing tools so this never drifts (release-repo #364).
Naming convention
list_*/find_*/get_* read; create_*/update_*/delete_* mutate; run_*/execute_* start work; *_from_yaml/*_from_swagger import. Most tools accept a human name as well as an id (progressive narrowing).
Explore
list_projects
List every project visible to the authenticated user.
No parameters.
list_project_applications
List the applications (services, UIs, mobile apps) registered under a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
resolve_swagger_url
Resolve the runtime swagger URL for an application in an environment.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
environment | string or integer | yes |
list_environments
List environments, optionally scoped to a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
find_scenarios
Discover API scenarios by partial name, tag, or auth/test type.
| Param | Type | Required | Description |
|---|---|---|---|
name_contains_text | string or null | no | |
project | string or integer or null | no | |
tags | array or null | no | |
test_type | string or null | no |
find_ui_tests
Discover UI (WebDriver/Playwright) tests by partial name or tag.
| Param | Type | Required | Description |
|---|---|---|---|
name_contains_text | string or null | no | |
project | string or integer or null | no | |
tags | array or null | no |
find_ui_test_suites
Discover UI test suites by partial name, optionally scoped to a project.
| Param | Type | Required | Description |
|---|---|---|---|
name_contains_text | string or null | no | |
project | string or integer or null | no |
list_pipelines
List pipelines, optionally scoped to a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
Act
create_api_scenario
Create an API test scenario.
| Param | Type | Required | Description |
|---|---|---|---|
base_url | string | yes | |
environment | string or integer | yes | |
name | string | yes | |
project | string or integer | yes | |
steps | array | yes | |
auth_config | object or null | no | |
credential_tag | string or null | no | |
description | string or null | no | |
run_immediately | boolean | no | |
tags | string or array or null | no |
execute_scenario
Kick off an API scenario execution.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
allow_unauthenticated | boolean | no | |
base_url | string or null | no | |
credential_tag | string or null | no | |
environment | string or integer or null | no | |
project | string or integer or null | no | |
summarize | boolean | no | |
tags | array or null | no | |
wait | boolean | no | |
wait_timeout_seconds | integer | no |
run_ui_test
Run a previously-authored UI test on one or more engines.
| Param | Type | Required | Description |
|---|---|---|---|
test | string or integer | yes | |
browsers | array or null | no | |
credential_tag | string or null | no | |
drivers | array or null | no | |
environment | string or integer or null | no | |
project | string or integer or null | no | |
summarize | boolean | no | |
tag | string or null | no | |
target | string or null | no | |
wait | boolean | no | |
wait_timeout_seconds | integer | no |
run_by_tag
Fan-out runner: queue every API scenario and/or UI test that matches
| Param | Type | Required | Description |
|---|---|---|---|
tags | array | yes | |
dry_run | boolean | no | |
environment | string or integer or null | no | |
kinds | array or null | no | |
project | string or integer or null | no |
run_pipeline
Kick off a pipeline run by name or id.
| Param | Type | Required | Description |
|---|---|---|---|
pipeline | string or integer | yes | |
environment | string or integer or null | no | |
project | string or integer or null | no |
Report
get_execution_status
Fetch raw status for an execution.
| Param | Type | Required | Description |
|---|---|---|---|
execution_id | integer or string | yes | |
kind | string or null | no |
summarize_execution
Return a 1-screen NL summary of an execution.
| Param | Type | Required | Description |
|---|---|---|---|
execution_id | integer or string | yes | |
kind | string or null | no |
get_crawl_results
Read crawl results for a UI crawl job, paginated by page.
| Param | Type | Required | Description |
|---|---|---|---|
job_id | string | yes | |
page_url | string or null | no |
UI test authoring
crawl_ui
Crawl a web app starting at a URL and return its element inventory.
| Param | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
engine | string | no | |
level | string | no | |
max_depth | integer | no | |
max_urls | integer | no | |
mode | string or null | no |
discover_form_fields
Discover form fields on a specific page — more structured than the
| Param | Type | Required | Description |
|---|---|---|---|
url | string | yes |
validate_ui_test_yaml
Schema-check UI test YAML before creation.
| Param | Type | Required | Description |
|---|---|---|---|
yaml_text | string | yes |
create_ui_test_from_yaml
Create a UI test from validated YAML.
| Param | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
yaml_text | string | yes | |
credential_tag | string or null | no | |
driver | string or null | no | |
feature | string or null | no | |
group_name | string or null | no | |
project | string or integer or null | no | |
run_immediately | boolean | no | |
tags | string or null | no | |
target | string or null | no |
run_ui_test_suite
Run a UI test suite — every test in the suite, optionally fanned
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
suite | string or integer | yes | |
credential_tag | string or null | no | |
drivers | array or null | no | |
tag | string or null | no | |
target | string or null | no |
recommend_engine
Recommend an engine for either CRAWLING a site or TESTING it.
| Param | Type | Required | Description |
|---|---|---|---|
purpose | string | no | |
target_id | integer or null | no | |
url | string or null | no |
crawl_by_target
Crawl a registered environment target by name (or id).
| Param | Type | Required | Description |
|---|---|---|---|
target | string or integer | yes | |
engine | string | no | |
environment | string or integer or null | no | |
level | string | no | |
max_depth | integer | no | |
max_urls | integer | no | |
mode | string or null | no | |
project | string or integer or null | no | |
wait_timeout_seconds | integer | no |
get_crawl_digest
Read the CACHED compact crawl digest for an env target — no re-crawl (release#302 Phase 2).
| Param | Type | Required | Description |
|---|---|---|---|
target | string or integer | yes | |
environment | string or integer or null | no | |
level | string | no | |
project | string or integer or null | no |
ensure_crawl_for_authoring
Get the element inventory for a URL — building block for the
| Param | Type | Required | Description |
|---|---|---|---|
url | string | yes | |
force_refresh | boolean | no | |
max_depth | integer | no | |
max_urls | integer | no | |
wait_timeout_seconds | integer | no |
get_ui_test
Fetch one UI test by name or id.
| Param | Type | Required | Description |
|---|---|---|---|
test | string or integer | yes |
update_ui_test_from_yaml
Update a UI test from a YAML doc (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
test | string or integer | yes | |
yaml_text | string | yes | |
credential_tag | string or null | no | |
description | string or null | no | |
driver | string or null | no | |
feature | string or null | no | |
group_name | string or null | no | |
name | string or null | no | |
tags | string or array or null | no |
delete_ui_test
Delete a UI test (soft-delete via status='ARCHIVED').
| Param | Type | Required | Description |
|---|---|---|---|
test | string or integer | yes | |
confirm | boolean | no |
list_ui_test_executions
List recent executions for a UI test, newest first.
| Param | Type | Required | Description |
|---|---|---|---|
test | string or integer | yes | |
limit | integer | no |
compare_ui_runs
Compare two UI-test jobs side-by-side.
| Param | Type | Required | Description |
|---|---|---|---|
job_a | string | yes | |
job_b | string | yes |
get_ui_execution_group
Fetch a matrix run (drivers × browsers fan-out) by its
| Param | Type | Required | Description |
|---|---|---|---|
execution_group_id | string | yes |
list_ui_test_actions
Discover the UI-test action vocabulary + per-action params.
No parameters.
create_ui_test_suite
Create a UI test suite, optionally populated and running.
| Param | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
project | string or integer | yes | |
description | string or null | no | |
environment | string or integer or null | no | |
items | array or null | no | |
reuse_browser | boolean | no | |
run_immediately | boolean | no |
get_ui_test_suite
Fetch one UI test suite by name or id, items included.
| Param | Type | Required | Description |
|---|---|---|---|
suite | string or integer | yes |
update_ui_test_suite
Edit suite metadata (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
suite | string or integer | yes | |
description | string or null | no | |
name | string or null | no | |
reuse_browser | boolean or null | no |
delete_ui_test_suite
Delete a UI test suite (ADMIN, requires confirm).
| Param | Type | Required | Description |
|---|---|---|---|
suite | string or integer | yes | |
confirm | boolean | no |
add_ui_test_to_suite
Add a UI test to a suite as a new item.
| Param | Type | Required | Description |
|---|---|---|---|
suite | string or integer | yes | |
test | string or integer | yes | |
sort_order | integer or null | no | |
target | string or integer or null | no | |
weight | integer | no |
remove_ui_test_from_suite
Remove a UI test from a suite by ITEM id (not test id).
| Param | Type | Required | Description |
|---|---|---|---|
item_id | integer | yes | |
suite | string or integer | yes |
reorder_ui_test_suite
Reorder a suite's items by passing item ids in the desired
| Param | Type | Required | Description |
|---|---|---|---|
item_ids_in_order | array | yes | |
suite | string or integer | yes |
list_ui_test_suite_executions
List recent suite runs, newest first.
| Param | Type | Required | Description |
|---|---|---|---|
suite | string or integer | yes | |
limit | integer | no |
API scenario authoring
parse_swagger
Parse an OpenAPI / Swagger spec into an endpoint inventory — or a compact digest.
| Param | Type | Required | Description |
|---|---|---|---|
app | string or null | no | |
app_tag | string or null | no | |
base_url | string or null | no | |
content | string or null | no | |
level | string | no | |
mode | string | no | |
url | string or null | no |
refresh_api_digest
Parse an app's spec in an environment and store a versioned digest (release#299).
| Param | Type | Required | Description |
|---|---|---|---|
app | string or integer | yes | |
environment | string or integer | yes |
detect_api_spec
Framework-aware API-spec detection (release#421).
| Param | Type | Required | Description |
|---|---|---|---|
app | string or integer or null | no | |
base_url | string or null | no | |
environment | string or integer or null | no |
get_api_digest
Read the cached versioned API digest — zero live parse (release#299).
| Param | Type | Required | Description |
|---|---|---|---|
app | string or integer | yes | |
environment | string or integer | yes | |
level | string | no | |
version | string or null | no |
put_api_digest
Store a curated user API digest version, optionally pinning it (release#299).
| Param | Type | Required | Description |
|---|---|---|---|
app | string or integer | yes | |
digest | object | yes | |
environment | string or integer | yes | |
version | string | yes | |
pin | boolean | no |
create_scenario_from_swagger
Bulk-generate atomic endpoint-level scenarios from a Swagger
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
project | string or integer | yes | |
app_tag | string or null | no | |
base_url | string or null | no | |
content | string or null | no | |
name | string or null | no | |
path_globs | array or null | no | |
run_immediately | boolean | no | |
tags | string or null | no | |
url | string or null | no |
create_sqlmap_scan_from_swagger
Convert a Swagger/OpenAPI spec into a SQLMap SQLi scan (release#346 Phase 3).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
project | string or integer | yes | |
app_tag | string or null | no | |
base_url | string or null | no | |
content | string or null | no | |
dbms | string or null | no | |
level | integer or null | no | |
name | string or null | no | |
path_globs | array or null | no | |
risk | integer or null | no | |
url | string or null | no |
validate_scenario_yaml
Schema-check an API scenario YAML before creation.
| Param | Type | Required | Description |
|---|---|---|---|
yaml_text | string | yes |
create_scenario_from_yaml
Create an API scenario from validated YAML.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
project | string or integer | yes | |
yaml_text | string | yes | |
run_immediately | boolean | no | |
tags | string or null | no |
get_api_scenario
Fetch one API scenario by name or id.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes |
get_scenario_yaml
Export a scenario as YAML — round-trippable with
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes |
update_api_scenario_from_yaml
Update a scenario from a YAML doc (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
yaml_text | string | yes |
delete_api_scenario
Delete a scenario (ADMIN only, requires confirm=True).
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
confirm | boolean | no |
list_scenario_executions
List recent executions for a scenario, newest first.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
limit | integer | no | |
project | string or integer or null | no |
test_scenario_auth
Pre-flight a scenario's auth without running the full scenario.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
auth_config | object or null | no |
list_scenario_groups
List scenario groups, optionally scoped to a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
get_scenario_group
Fetch one scenario group by name or id, items included.
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes |
create_scenario_group
Create a scenario group, optionally populated and run.
| Param | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
project | string or integer | yes | |
description | string or null | no | |
environment | string or integer or null | no | |
execution_mode | string | no | |
run_immediately | boolean | no | |
scenarios | array or null | no |
update_scenario_group
Edit group metadata (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes | |
description | string or null | no | |
environment | string or integer or null | no | |
execution_mode | string or null | no | |
name | string or null | no |
delete_scenario_group
Delete a scenario group (ADMIN, requires confirm).
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes | |
confirm | boolean | no |
add_scenarios_to_group
Append scenarios to a group (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes | |
scenarios | array | yes |
remove_scenarios_from_group
Remove items from a group by ITEM id (not scenario id).
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes | |
item_ids | array | yes |
execute_scenario_group
Kick off a scenario group run.
| Param | Type | Required | Description |
|---|---|---|---|
group | string or integer | yes |
Performance
find_performance_scenarios
Discover performance (Artillery) scenarios.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
get_performance_test_types
List the test-type enum the platform accepts for performance
No parameters.
create_performance_scenario
Author a performance scenario.
| Param | Type | Required | Description |
|---|---|---|---|
base_url | string | yes | |
environment | string or integer | yes | |
name | string | yes | |
project | string or integer | yes | |
application | string or integer or null | no | |
artillery_config | object or null | no | |
auth_config | object or null | no | |
credential_tag | string or null | no | |
description | string or null | no | |
max_error_rate | number or null | no | |
p95_threshold_ms | integer or null | no | |
p99_threshold_ms | integer or null | no | |
run_immediately | boolean | no | |
tags | string or array or null | no | |
test_type | string | no |
convert_api_to_performance_scenario
Convert an existing API scenario into a performance (Artillery)
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
auth_per_vu_login | object or null | no | |
auth_refresh_on_401 | boolean or null | no | |
data | array or null | no | |
description | string or null | no | |
duration | integer or null | no | |
load_mode | string | no | |
max_error_rate | number or null | no | |
name | string or null | no | |
p95_threshold_ms | integer or null | no | |
p99_threshold_ms | integer or null | no | |
per_endpoint_slos | array or null | no | |
phase_pattern | string or null | no | |
phases | array or null | no | |
run_immediately | boolean | no | |
slo_preset | string or null | no | |
vus | integer or null | no |
validate_performance_scenario
§12 pre-flight dry-validate — run the flow ONCE (1 VU, 1 iteration) and verify it
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
force_target | boolean | no | |
poll_timeout_s | integer | no |
run_performance_scenario
Kick off a performance run. Returns a ScanJob with a UUID
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
environment | string or integer or null | no | |
project | string or integer or null | no | |
tags | string or array or null | no | |
target_url | string or null | no |
get_performance_history
List recent runs of a performance scenario. Most-recent first.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
limit | integer | no | |
project | string or integer or null | no |
get_performance_result
SLO outcome of a perf run — real p95 / error-rate metrics + declared thresholds + pass/fail.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
job_id | string or null | no | |
project | string or integer or null | no |
get_performance_scenario
Fetch one performance scenario by name or id.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes |
update_performance_scenario
Update a performance scenario (read-merge-write).
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
artillery_config | object or null | no | |
auth_config | object or null | no | |
base_url | string or null | no | |
command_template | string or null | no | |
credential_tag | string or null | no | |
description | string or null | no | |
duration | integer or null | no | |
endpoints | array or null | no | |
environment | string or integer or null | no | |
load_mode | string or null | no | |
max_error_rate | number or null | no | |
name | string or null | no | |
p95_threshold_ms | integer or null | no | |
p99_threshold_ms | integer or null | no | |
phase_pattern | string or null | no | |
phases | array or null | no | |
project | string or integer or null | no | |
tags | string or array or null | no | |
test_type | string or null | no | |
vus | integer or null | no |
delete_performance_scenario
Permanently delete a performance scenario (ADMIN only).
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
confirm | boolean | no |
deactivate_performance_scenario
Soft-delete: flip is_active to false.
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes |
Admin & configuration
create_project
Create a new project (MCP-PROJ-01, #196).
| Param | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
description | string or null | no |
link_environment
Link an environment to a project (MCP-PROJ-05, #200).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
project | string or integer | yes |
unlink_environment
Unlink an environment from a project (MCP-PROJ-05, #200).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
project | string or integer | yes |
create_application
Create an application under a project (MCP-APP-01, #202).
| Param | Type | Required | Description |
|---|---|---|---|
application_type | string | yes | |
name | string | yes | |
project | string or integer | yes | |
app_tag | string or null | no | |
application_tech | string or null | no | |
auth_requirement | string or null | no | |
default_branch | string or null | no | |
description | string or null | no | |
git_credential_tag | string or null | no | |
git_provider | string or null | no | |
git_url | string or null | no | |
jira_enabled | boolean or null | no | |
jira_project_key | string or null | no | |
multi_repo | boolean or null | no | |
registry_credential_tag | string or null | no | |
registry_type | string or null | no | |
registry_url | string or null | no | |
repo_path | string or null | no | |
swagger_path | string or null | no |
create_environment
Create an environment (MCP-ENV-01, #207).
| Param | Type | Required | Description |
|---|---|---|---|
name | string | yes | |
auth_requirement | string or null | no | |
description | string or null | no | |
project | string or integer or null | no | |
variables | object or null | no |
add_target
Add an environment target (MCP-TGT-01, #211 — P0 demo-blocker).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
name | string | yes | |
active | boolean | no | |
app_tag | string or null | no | |
application | string or integer or null | no | |
base_url | string or null | no | |
cidr | string or null | no | |
crawler_config | object or null | no | |
db_name | string or null | no | |
db_type | string or null | no | |
endpoint | string or null | no | |
healthcheck_path | string or null | no | |
home_page_url | string or null | no | |
host | string or null | no | |
ip | string or null | no | |
metadata | object or null | no | |
port | integer or null | no | |
protocol | string or null | no | |
swagger_path | string or null | no | |
target_type | string | no |
list_targets
List env_targets across environments (MCP-TGT-03, #213).
| Param | Type | Required | Description |
|---|---|---|---|
active_only | boolean | no | |
app_tag | string or null | no | |
environment | string or integer or null | no | |
with_swagger_only | boolean | no |
update_project
Update a project's name or description (MCP-PROJ-02, #197).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
description | string or null | no | |
name | string or null | no |
delete_project
Permanently delete a project (MCP-PROJ-03, #198).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
confirm | boolean | no |
toggle_project_status
Flip a project's active flag (MCP-PROJ-04, #199).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
get_project_setup_status
Project onboarding readiness check (MCP-PROJ-06, #201).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
update_application
Update an application (MCP-APP-02, #203).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
app_tag | string or null | no | |
application_tech | string or null | no | |
application_type | string or null | no | |
auth_requirement | string or null | no | |
default_branch | string or null | no | |
description | string or null | no | |
git_credential_tag | string or null | no | |
git_provider | string or null | no | |
git_url | string or null | no | |
jira_enabled | boolean or null | no | |
jira_project_key | string or null | no | |
mode | string | no | |
multi_repo | boolean or null | no | |
name | string or null | no | |
project | string or integer or null | no | |
registry_credential_tag | string or null | no | |
registry_type | string or null | no | |
registry_url | string or null | no | |
repo_path | string or null | no | |
swagger_path | string or null | no |
delete_application
Delete an application (MCP-APP-03, #204).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
confirm | boolean | no | |
project | string or integer or null | no |
link_application_to_project
Link an application to a project (MCP-APP-04, #205).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes |
unlink_application_from_project
Unlink an application from a project (MCP-APP-04, #205).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes |
list_application_projects
List the projects an application is linked to (MCP-APP-04, #205).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes |
list_applications
List all applications across projects (MCP-APP-05, #206).
| Param | Type | Required | Description |
|---|---|---|---|
application_type | string or null | no |
get_application
Get full application detail (MCP-APP-05, #206).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes |
update_environment
Update env metadata (MCP-ENV-02, #208).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
auth_requirement | string or null | no | |
description | string or null | no | |
name | string or null | no |
delete_environment
Permanently delete an environment (MCP-ENV-03, #209).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
confirm | boolean | no |
toggle_environment_status
Flip an environment's active flag (MCP-ENV-03, #209).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
get_environment
Get full environment detail (MCP-ENV-04, #210).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
get_target
Get a single environment target by name or id (release#411, #457).
| Param | Type | Required | Description |
|---|---|---|---|
target | string or integer | yes |
update_target
Update an environment target (MCP-TGT-02, #212).
| Param | Type | Required | Description |
|---|---|---|---|
target | integer | yes | |
active | boolean or null | no | |
app_tag | string or null | no | |
application | string or integer or null | no | |
base_url | string or null | no | |
cidr | string or null | no | |
crawler_config | object or null | no | |
db_name | string or null | no | |
db_type | string or null | no | |
endpoint | string or null | no | |
healthcheck_path | string or null | no | |
home_page_url | string or null | no | |
host | string or null | no | |
ip | string or null | no | |
metadata | object or null | no | |
name | string or null | no | |
port | integer or null | no | |
protocol | string or null | no | |
swagger_path | string or null | no |
set_target_auth
Set an environment target's PER-TARGET authConfig — the #388 per-target login config (release#396).
| Param | Type | Required | Description |
|---|---|---|---|
auth_config | object | yes | |
target | integer | yes |
get_target_auth
Read an environment target's authConfig by name or id (release#396, #457). Wraps ``GET
| Param | Type | Required | Description |
|---|---|---|---|
target | string or integer | yes |
delete_target
Delete an environment target (MCP-TGT-02, #212).
| Param | Type | Required | Description |
|---|---|---|---|
target | integer | yes | |
confirm | boolean | no |
list_env_variables
List environment variables (MCP-ENV-VAR-01, #215).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
set_env_variables
Bulk-add or update environment variables (MCP-ENV-VAR-01, #215).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
variables | object | yes |
update_env_variable
Update a single env variable (MCP-ENV-VAR-01, #215).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
key | string | yes | |
value | string | yes | |
description | string or null | no | |
is_secret | boolean | no |
delete_env_variable
Delete a single env variable (MCP-ENV-VAR-01, #215).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
key | string | yes | |
confirm | boolean | no |
onboard_project
One-shot onboarding for a fresh tenant (MCP-ONBOARD-01, #221).
| Param | Type | Required | Description |
|---|---|---|---|
project_name | string | yes | |
applications | array or null | no | |
environments | array or null | no | |
project_description | string or null | no |
list_environment_credential_tags
List the credential tags configured in an environment's vault.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
list_environment_credentials
List full credential records in an environment's vault.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
get_environment_credential
Fetch one credential by its tag from the env vault.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes |
set_environment_credential_active
Activate or deactivate an environment credential by tag (release#412 GAP 6).
| Param | Type | Required | Description |
|---|---|---|---|
active | boolean | yes | |
environment | string or integer | yes | |
tag | string | yes |
set_environment_auth_endpoint
Set the environment LOGIN config (authEndpoint) — release#422.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
login_endpoint | string | yes | |
auth_type | string | no | |
custom_headers | object or null | no | |
login_body_template | string or object or null | no | |
login_method | string | no | |
refresh_endpoint | string or null | no | |
token_expiry_seconds | integer or null | no | |
token_json_path | string | no |
get_environment_auth_endpoint
Read the environment LOGIN config (authEndpoint) — release#422.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes |
add_environment_credential
Add a credential to the env vault.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes | |
api_key_name | string or null | no | |
api_key_value | string or null | no | |
app_tag | string or null | no | |
client_id | string or null | no | |
client_secret | string or null | no | |
description | string or null | no | |
is_active | boolean | no | |
is_default | boolean | no | |
password | string or null | no | |
target_patterns | array or null | no | |
token | string or null | no | |
username | string or null | no |
update_environment_credential
Update / rotate an existing credential by tag.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes | |
api_key_name | string or null | no | |
api_key_value | string or null | no | |
app_tag | string or null | no | |
client_id | string or null | no | |
client_secret | string or null | no | |
description | string or null | no | |
is_active | boolean or null | no | |
is_default | boolean or null | no | |
password | string or null | no | |
target_patterns | array or null | no | |
token | string or null | no | |
username | string or null | no |
delete_environment_credential
Delete a credential by tag (DESTRUCTIVE — requires confirm=True).
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes | |
confirm | boolean | no |
set_default_credential
Set an env's default credential tag.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes |
ensure_environment_credential
Idempotent upsert — add if absent, update if present.
| Param | Type | Required | Description |
|---|---|---|---|
environment | string or integer | yes | |
tag | string | yes | |
api_key_name | string or null | no | |
api_key_value | string or null | no | |
app_tag | string or null | no | |
client_id | string or null | no | |
client_secret | string or null | no | |
description | string or null | no | |
is_active | boolean or null | no | |
is_default | boolean or null | no | |
password | string or null | no | |
target_patterns | array or null | no | |
token | string or null | no | |
username | string or null | no |
Releases
get_release_readiness
The headline release-readiness score for a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
application | string or integer or null | no | |
environment | string or integer or null | no | |
since_days | integer or null | no | |
tag | string or null | no |
recommend_release_coverage
Recommend the test coverage a release (project) should have — the Release-Coverage Advisor (#199).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
environment | string or integer or null | no |
get_release_readiness_trend
Readiness trend over time — time series of the overall
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
days | integer | no | |
environment | string or integer or null | no | |
tag | string or null | no |
get_score_config
Get a project's 8 release-readiness thresholds.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
set_score_config
Update a project's release-readiness thresholds (partial
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
api_pass_rate_threshold | number or null | no | |
min_endpoint_coverage_pct | integer or null | no | |
perf_p95_threshold_ms | integer or null | no | |
perf_required | boolean or null | no | |
require_code_review | boolean or null | no | |
security_max_critical | integer or null | no | |
security_max_high | integer or null | no | |
ui_pass_rate_threshold | number or null | no |
list_releases
List all releases (tags) for an application within a project.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes |
get_release
Fetch one release by version.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes | |
version | string | yes |
delete_release
Delete a recorded release (the platform's release record).
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes | |
version | string | yes |
auto_tag_release
Auto-bump and tag a release.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes | |
bump_type | string or null | no | |
from_tag | string or null | no | |
push_tag | boolean | no | |
to_tag | string or null | no | |
version | string or null | no |
generate_release_notes
Generate release notes from commits.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
project | string or integer | yes | |
from_tag | string or null | no | |
to_tag | string or null | no | |
version | string or null | no |
approve_deployment_gate
Approve a manual deployment gate.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
gate_id | string | yes | |
job_id | string | yes | |
project | string or integer | yes | |
comment | string or null | no |
evaluate_deployment_gate
Trigger evaluation of an automated deployment gate.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
gate_id | string | yes | |
job_id | string | yes | |
project | string or integer | yes | |
pass_criteria | object or null | no |
Quality gates
create_quality_gate
Create a quality gate flow.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
environment | string or integer | yes | |
name | string | yes | |
steps | array | yes | |
description | string or null | no | |
run_on_tag | boolean | no |
list_quality_gates
List quality gate flows.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer or null | no |
get_quality_gate
Fetch a quality gate flow by name or id.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes |
update_quality_gate
Update a quality gate flow (partial update — only fields you
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
description | string or null | no | |
name | string or null | no | |
steps | array or null | no |
delete_quality_gate
Delete a quality gate flow (destructive).
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
confirm | boolean | no |
run_quality_gate
Start a quality gate run for a release tag.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
version | string | yes |
list_quality_gate_runs
List all runs for a quality gate, most-recent first.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes |
get_quality_gate_run
Fetch one quality gate run with per-step status.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
run_id | integer | yes |
approve_quality_gate_step
Approve a WAITING_APPROVAL step on a quality gate run.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
run_id | integer | yes | |
step_id | integer | yes |
submit_quality_gate_step_result
Report a step's outcome back to the gate run.
| Param | Type | Required | Description |
|---|---|---|---|
gate | string or integer | yes | |
run_id | integer | yes | |
status | string | yes | |
step_id | integer | yes | |
error_message | string or null | no | |
result_summary | object or null | no |
Findings
get_findings_summary
Aggregate findings counts for a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
environment | string or integer or null | no | |
severities | array or null | no | |
since | string or null | no | |
until | string or null | no |
find_findings
Search findings with full filtering.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes | |
environment | string or integer or null | no | |
page | integer | no | |
q | string or null | no | |
scan | string or integer or null | no | |
scanId | string or null | no | |
scan_id | string or null | no | |
severities | array or null | no | |
since | string or null | no | |
size | integer | no | |
tool | string or null | no | |
until | string or null | no |
get_findings_lifecycle_stats
Status distribution histogram for a project's findings.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
update_finding_status
Transition a finding's lifecycle status (triage / fix /
| Param | Type | Required | Description |
|---|---|---|---|
finding_id | integer | yes | |
status | string | yes | |
notes | string or null | no | |
triaged_by | string or null | no |
get_test_results_summary
Pass/fail rollup across all test kinds for a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer | yes |
find_test_results
Search across all test-result rows (API, UI, perf, mobile, …).
| Param | Type | Required | Description |
|---|---|---|---|
page | integer | no | |
project | string or integer or null | no | |
size | integer | no | |
status | string or null | no | |
test_type | string or null | no |
fetch_slice
Return one record's FULL detail from a compacted result set (#179).
| Param | Type | Required | Description |
|---|---|---|---|
handle | string | yes | |
id | integer | yes |
Performance criteria
get_performance_criteria
Fetch an application's performance acceptance criteria.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes |
update_performance_criteria
Create or update an application's performance SLO thresholds.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
environments_required | string or null | no | |
max_error_rate_percent | number or null | no | |
max_mean_response_ms | integer or null | no | |
max_regression_percent | integer or null | no | |
min_endpoint_coverage_percent | integer or null | no | |
min_peak_arrival_rate | integer or null | no | |
min_sustained_duration_sec | integer or null | no | |
min_throughput_rps | integer or null | no | |
p95_threshold_ms | integer or null | no | |
p99_threshold_ms | integer or null | no | |
require_peak_phase | boolean or null | no | |
require_sustained_phase | boolean or null | no | |
require_warmup_phase | boolean or null | no | |
zero_5xx_required | boolean or null | no |
delete_performance_criteria
Wipe an application's performance criteria bundle.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
confirm | boolean | no |
add_performance_criterion
Add a single performance done-item.
| Param | Type | Required | Description |
|---|---|---|---|
application | string or integer | yes | |
name | string | yes | |
category | string | no | |
check_type | string | no | |
description | string or null | no | |
is_required | boolean | no | |
metric | string or null | no | |
operator | string or null | no | |
sort_order | integer or null | no | |
threshold_value | number or null | no | |
unit | string or null | no |
update_performance_criterion
Update a done-item's fields (partial update — only the
| Param | Type | Required | Description |
|---|---|---|---|
item_id | integer | yes | |
actual_value | number or null | no | |
checked_by | string or null | no | |
description | string or null | no | |
name | string or null | no | |
notes | string or null | no | |
status | string or null | no |
delete_performance_criterion
Delete a single done-item.
| Param | Type | Required | Description |
|---|---|---|---|
item_id | integer | yes | |
confirm | boolean | no |
check_performance_criterion
Flip a done-item's status (the fast path).
| Param | Type | Required | Description |
|---|---|---|---|
item_id | integer | yes | |
status | string | yes |
Playbooks
find_playbooks
Discover guided test-authoring playbooks by intent.
| Param | Type | Required | Description |
|---|---|---|---|
intent | string or null | no |
get_playbook
Read one playbook in full (its beats + tool_sequence + parameters).
| Param | Type | Required | Description |
|---|---|---|---|
playbook | string or integer | yes |
create_playbook
Create a new playbook (a stored guided test-authoring recipe).
| Param | Type | Required | Description |
|---|---|---|---|
beats | string | yes | |
category | string | yes | |
name | string | yes | |
description | string or null | no | |
digest_app_tag | string or null | no | |
digest_version | string or null | no | |
intent | string or null | no | |
parameters | array or null | no | |
project | string or integer or null | no | |
tags | string or null | no | |
template | string or null | no | |
tool_sequence | array or null | no | |
triggers | array or null | no |
instantiate_playbook
Fill a playbook's stored blank template into a runnable scenario (release#295).
| Param | Type | Required | Description |
|---|---|---|---|
playbook | string or integer | yes | |
dry_run | boolean | no | |
environment | string or integer or null | no | |
project | string or integer or null | no | |
run_immediately | boolean | no | |
values | object or null | no |
Intent
act_on_intent
Compile ONE plain sentence into a confirmable test plan (#168, claim 1′).
| Param | Type | Required | Description |
|---|---|---|---|
sentence | string | yes | |
environment | string or integer or null | no | |
playbook | string or integer or null | no | |
project | string or integer or null | no |
record_resolution_hint
Remember a human's correction so the SAME intent resolves it without asking again (#168 B5).
| Param | Type | Required | Description |
|---|---|---|---|
param | string | yes | |
sentence | string | yes | |
value | string | yes | |
environment | string or integer or null | no |
Test data
upload_test_data
Upload a CSV as a reusable DataSet for data-driven load tests.
| Param | Type | Required | Description |
|---|---|---|---|
csv | string | yes | |
name | string | yes | |
app_name | string or null | no | |
dataset_version | string or null | no | |
delimiter | string | no | |
has_header | boolean | no | |
project | string or integer or null | no |
list_test_data_sets
List DataSets, optionally filtered to a project.
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
preview_test_data
Preview the first n lines of a DataSet's CSV.
| Param | Type | Required | Description |
|---|---|---|---|
dataset | integer | yes | |
n | integer | no |
delete_test_data
Delete a DataSet (row + its CSV object). Requires confirm=true. A shared DataSet
| Param | Type | Required | Description |
|---|---|---|---|
dataset | integer | yes | |
confirm | boolean | no |
Security scans
validate_security_scan_yaml
Validate a security-scan action-format definition WITHOUT storing or running it.
| Param | Type | Required | Description |
|---|---|---|---|
yaml_text | string | yes |
create_security_scan
Store a security-scan definition (the action-format envelope + actions[]).
| Param | Type | Required | Description |
|---|---|---|---|
yaml_text | string | yes | |
environment | string or integer or null | no | |
project | string or integer or null | no |
create_sqlmap_scan_from_scenario
Convert an API test (scenario) into a SQLMap SQLi scan (release#346) — the easiest way to
| Param | Type | Required | Description |
|---|---|---|---|
scenario | string or integer | yes | |
dbms | string or null | no | |
level | integer or null | no | |
name | string or null | no | |
risk | integer or null | no |
get_security_scan
Get a stored security-scan definition by id (release#384 Gap 1).
| Param | Type | Required | Description |
|---|---|---|---|
scan | integer | yes |
list_security_scans
List stored security-scan definitions (release#384 Gap 1).
| Param | Type | Required | Description |
|---|---|---|---|
project | string or integer or null | no |
update_security_scan
Update (full-replace) a stored security-scan definition (release#384 Gap 1).
| Param | Type | Required | Description |
|---|---|---|---|
scan | integer | yes | |
yaml_text | string | yes | |
environment | string or integer or null | no | |
project | string or integer or null | no |
delete_security_scan
Delete a stored security-scan definition (release#405). Wraps ``DELETE
| Param | Type | Required | Description |
|---|---|---|---|
scan | integer | yes |
run_security_scan
Run a stored security scan — fan each action out to a scanner job.
| Param | Type | Required | Description |
|---|---|---|---|
scan | integer | yes | |
tags | array or null | no |
get_security_scan_result
Gating verdict for a security-scan run — PASS/FAIL + severity counts.
| Param | Type | Required | Description |
|---|---|---|---|
run | integer | yes |
list_nse_scripts
Classified Nmap NSE catalog — build a SAFE options.scripts list for an NMAP action.
No parameters.
Registry credentials
register_registry_credential
Store a PRIVATE registry pull credential in the global vault (ADMIN-only).
| Param | Type | Required | Description |
|---|---|---|---|
provider | string | yes | |
tag | string | yes | |
auth | object or null | no | |
description | string or null | no | |
registry_host | string or null | no | |
secret | string or null | no | |
username | string or null | no |
list_registry_credentials
List registry pull credentials in the vault (ADMIN-only). Secrets are scrubbed to *** —
No parameters.
get_registry_credential
Get one registry pull credential by tag (or id), ADMIN-only. The secret is scrubbed to
| Param | Type | Required | Description |
|---|---|---|---|
tag | string | yes |
update_registry_credential
Update / rotate a registry pull credential (by tag or id), ADMIN-only. Only the fields you
| Param | Type | Required | Description |
|---|---|---|---|
tag | string | yes | |
auth | object or null | no | |
description | string or null | no | |
is_active | boolean or null | no | |
provider | string or null | no | |
registry_host | string or null | no | |
secret | string or null | no | |
username | string or null | no |
delete_registry_credential
Delete a registry pull credential from the global vault (by tag or id), ADMIN-only.
| Param | Type | Required | Description |
|---|---|---|---|
tag | string | yes | |
confirm | boolean | no |
Tool catalog
get_tool_catalog
Compact, tiered catalog of this MCP's tools (release#427) — discover capabilities for a
| Param | Type | Required | Description |
|---|---|---|---|
category | string or null | no | |
name | string or null | no | |
tier | string | no |