CAST Gatekeeper MCP Server tools reference
Overview
Tools are functions the AI agent can call directly. Each tool maps to one or more Dashboard REST API call.
list_applications
List every application the current API key can access. The AI client calls this tool first when it does not know the exact application name.
Example:
- “Get application list for Gatekeeper MCP server”
get_mcp_info
Check the Gatekeeper MCP Server’s version and confirm it is compatible with your connected CAST Imaging installation. Reports the running MCP Server version, the connected CAST Imaging version, and the minimum required version.
Example natural-language queries:
- “What version of the MCP server am I running?”
- “Check if my Console is compatible with this MCP server”
- “Show me the server info”
get_compliance_status
Get compliance status - quality indicators, violation counts, and health factors for an application.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Exact application name in Dashboard |
quality_indicators |
string | No | Comma-separated criterion IDs e.g. "60016,60013". Omit for all criteria. |
snapshot |
string | No | See Snapshot syntax. Default = latest. |
standard |
string | No | Filter by standard name substring, e.g. "ISO-5055", "CISQ" or "OWASP" |
technologies |
string | No | e.g. "JEE,HTML5" or "$all" |
modules |
string | No | Comma-separated module filter |
include_technical_criteria |
boolean | No | Set true to drill into the technical criteria of the business criterion given in quality_indicators. Default: false |
include_quality_rules |
boolean | No | Set true to drill into the quality rules of the technical criterion given in quality_indicators. Default: false |
The drill-down goes from the overview (no quality_indicators), to the technical criteria of a business criterion (quality_indicators=<business-criterion-id> and include_technical_criteria=true), to the quality rules of a technical criterion (quality_indicators=<technical-criterion-id> and include_quality_rules=true). Use get_violations with rule_pattern=<rule-id> to list the occurrences of a rule.
Example natural-language queries:
- “Show me the compliance status for MyApp”
- “Compare security violations between snapshot 5 and 6 for MyApp”
- “Get quality indicators for MyApp filtered by JEE technology”
get_technical_debt
Get technical debt metrics - remediation effort in minutes and equivalent 8-hour work days.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Application name |
snapshot |
string | No | Snapshot selector |
quality_indicators |
string | No | Criterion ID to drill into (e.g. "60016") |
include_technical_criteria |
boolean | No | Return technical criteria debt breakdown |
include_quality_rules |
boolean | No | Return quality rules debt breakdown, for a technical criterion given in quality_indicators |
scope |
string | No | Business criterion name, e.g. "Security". Use quality_indicators instead when you have a criterion ID |
technologies |
string | No | Technology filter |
modules |
string | No | Comma-separated module filter |
Example natural-language queries:
- “How many days of technical debt does MyApp have?”
- “Show technical debt breakdown by health factor for MyApp”
- “What is the security-related debt for MyApp in the last 3 months?”
get_violations
Get detailed violations with file paths, line numbers, rule details, and remedial actions. Supports pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Application name |
snapshot |
string | No | Snapshot selector |
business_criterion |
string | No | Criterion ID or name (e.g. "60016" or "Security"). Default: Total Quality Index (60017). |
rule_pattern |
string | No | "ISO-5055", "CISQ", a rule ID, or "none" - see the note below |
status |
string | No | "added", "updated", "unchanged", or "none" (all) |
technologies |
string | No | Technology filter |
nb_rows |
int / string | No | Violations per page: 1-10000 or "$all". When omitted, the server asks the user |
start_row |
int | No | Pagination offset. Default: 1 |
include_findings |
boolean | No | Include the rule description, rationale, remediation and inline source code. Default: true |
object_fullname |
string | No | Filter to a specific component by full name (e.g. “com.myapp.MyClass”). Supports substring match. |
standard |
string | No | Terminology to use in the answer, e.g. "ISO-5055" returns occurrences and characteristics instead of violations and quality indicators |
For the CAST business criteria (60011 to 60017, 66031 to 66033), when no rule_pattern is given, the server returns only violations of critical rules. Set rule_pattern="none" to return all violations for the criterion.
Example natural-language queries:
- “List the top 50 security violations added in the latest snapshot of MyApp”
- “Show me ISO-5055 violations for MyApp with source code locations”
- “Get all unchanged Robustness violations for MyApp in JEE technology”
get_objects
Get objects (classes, methods, files, etc.) for an application snapshot, sorted by name, with their violated rules.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Application name |
snapshot |
string | Yes | Snapshot to query. See Snapshot syntax. |
limit |
int | No | Max objects per page. Default: 25 |
skip |
int | No | Objects to skip (pagination) |
standard |
string | No | Quality standard filter (e.g. "ISO-5055", "CISQ"); takes precedence over business_criterion |
business_criterion |
string | No | Criterion ID to filter objects with at least one violation under it. Default: 60017 |
name |
string | No | Filter by object name (comma-separated for multiple) |
fullname |
string | No | Filter by full name including package/namespace |
filepath |
string | No | Filter by source file path |
object_type |
string | No | Filter by object type (comma-separated, e.g. "Java Method,Java Field") |
operator |
string | No | Match strategy: "contains" (default), "equals", "startswith", "endswith" |
Example natural-language queries:
- “List objects in MyApp’s latest snapshot”
- “List Java methods in MyApp’s latest snapshot with a name starting with "get"”
- “Show objects in MyApp snapshot 6 with at least one Security violation”
- “Find objects in MyApp whose file path contains "controllers"”
- “List ISO-5055 objects in MyApp, sorted by name, 50 per page”
- “Show the next page of objects, skipping the first 50”
manage_action_plan
Get, add, edit, or delete action plan issues for an application. Adding, editing, or deleting requires the QUALITY_MANAGER role.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Application name |
operation |
string | Yes | "get", "add", "edit", or "delete" |
snapshot |
string | No | (get only) Snapshot selector. Default: latest |
status |
string | No | (get only) "added", "pending", or "solved" |
tag |
string | No | Remedial priority: "extreme", "high", "moderate" or "low". Filter for get; value to set for add/edit |
nb_rows / start_row |
int | No | (get only) Pagination |
component_href |
string | Cond. | component.href from the target violation. Required for add/edit/delete |
rule_pattern_href |
string | Cond. | rulePattern.href from the target violation. Required for add/edit/delete |
comment |
string | No | (add/edit only) Remedial action comment |
items |
list | No | (add/edit/delete) List of {component_href, rule_pattern_href, comment, tag} to submit several violations in one call |
To convert an exclusion into an action plan item, call the tool with operation="add" directly. Do not delete the exclusion first - the backend automatically removes the matching exclusion.
Example natural-language queries:
- “Show me the action plan for MyApp”
- “List pending action plan items for MyApp in snapshot 6”
- “Show high-priority action plan issues for MyApp that are still unsolved”
- “Add MyApp’s violation on component X, rule Y to the action plan with high priority and comment "fix in next sprint"”
- “Change the priority of that action plan item to moderate and update the comment to "scheduled for Q3"”
- “Remove the action plan entry for component X, rule Y in MyApp”
- “Move MyApp’s excluded violation on component X, rule Y into the action plan instead”
manage_exclusion
Get, add, edit, or delete exclusion requests for an application. Adding, editing, or deleting requires the EXCLUSION_MANAGER role.
| Parameter | Type | Required | Description |
|---|---|---|---|
application_name |
string | Yes | Application name |
operation |
string | Yes | "get", "add", "edit", or "delete" |
exclusion_type |
string | No | (get only) "active" (effectively excluded), "scheduled" (pending, default), or "both" |
snapshot |
string | No | (get only) Snapshot selector. Default: latest |
status |
string | No | (get, scheduled only) "to-add", "to-remove", or "$all" |
nb_rows / start_row |
int | No | (get only) Pagination |
component_href |
string | Cond. | component.href from the target violation. Required for add/edit/delete |
rule_pattern_href |
string | Cond. | rulePattern.href from the target violation. Required for add/edit/delete |
comment |
string | Cond. | Exclusion justification. Required for add, optional for edit |
items |
list | No | (add/edit/delete) List of {component_href, rule_pattern_href, comment} to submit several violations in one call |
Creating an exclusion for a violation that is already in the action plan removes it from the action plan automatically.
Example natural-language queries:
- “Show all active exclusions for MyApp”
- “Show scheduled exclusions for MyApp that are pending removal”
- “List every exclusion, active and scheduled, for MyApp in snapshot 6”
- “Exclude MyApp’s violation on component X, rule Y with comment "false positive, confirmed by security team"”
- “Update the exclusion comment for component X, rule Y to "re-confirmed after code review"”
- “Remove the exclusion request for component X, rule Y in MyApp”