Required permissions
Soundcheck checks permissions twice: when it shows a tool to a user and when that user runs it. If the second check fails, the call returnsNotAllowedError. Before upgrading, check which permissions your policy grants for the actions your users need. This matters especially for policies that deny access unless you grant it explicitly.
Both
list-entity-facts and get-fact-data require soundcheck.fact.read to appear and to run. The first returns fact names and timestamps; the second returns fact values. Neither action checks soundcheck.fact.sensitive.read. If your fact values may be sensitive, account for that when granting soundcheck.fact.read. Other ways of reading sensitive facts have separate requirements.
Manual result and exemption tools need two permissions. The .manage permission lets users see the tool. The .update permission lets them change the chosen catalog entity. Grant both to users who need to make those changes.
The backend checks soundcheck.entity.exemptions.read for the two exemption list actions, but does not register that permission. Check whether your installed version supports it before using it in a policy.
Checks
create-check
Creates a new check definition in Soundcheck. Omit rule (with type default) to create an external check.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
update-check
Updates an existing check definition. Supports both standard and external checks. Only provided fields are changed.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
delete-check
Permanently deletes a check definition. Supports both standard and external checks. Fails if the check is still referenced by active (non-draft) tracks.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
list-checks
Returns all registered Soundcheck checks.
Attributes: readOnly: true · idempotent: true
Parameters: None
Returns:
get-check-definition
Returns what a check evaluates: rule type, fact collectors, pass criteria, and pass/fail messages.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-check-details
Returns the full details of a check, including pass/fail counts and the tracks that reference it.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
execute-check
Triggers a check to run on a component and persists the result. Manual-type checks cannot be executed; use set-manual-check-result instead.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
set-manual-check-result
Sets the pass/fail result for a manual-type check on a component, with a justification.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
get-check-failure-details
Returns exactly why a check is failing for a component: actual value, expected value, fact data, and failure reason.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-check-history
Returns the last 30 days of pass/fail history for a check on a given entity, along with a trend indicator.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
search-checks
Searches for checks by keyword, returning matching checks with descriptions and associated tracks.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
list-check-entities
Returns entities for a check, optionally filtered by result state, owner, kind, and lifecycle.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Tracks
create-track
Creates a new compliance track with specified checks and levels.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
update-track
Updates an existing track. Only provided fields are changed.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
delete-track
Permanently deletes a track. Fails if still referenced by active (non-archived) campaigns.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
list-tracks
Returns all registered Soundcheck tracks with their IDs, names, and level names.
Attributes: readOnly: true · idempotent: true
Parameters: None
Returns:
get-track-details
Returns the full configuration of a track: name, description, owner, levels with check IDs, and entity filter.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-track-stats
Returns adoption metrics for a track: component counts and percentage at each compliance level.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
list-track-blockers
Returns the most common failing checks in a track, with failure counts and the percentage of components failing each check.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Campaigns
create-campaign
Creates a new compliance campaign with a track, milestones, and entity filters.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
update-campaign
Updates an existing campaign. Only provided fields are changed.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
delete-campaign
Permanently deletes a campaign.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
list-campaigns
Returns all Soundcheck campaigns with their IDs, names, status, associated track IDs, and date ranges.
Attributes: readOnly: true · idempotent: true
Parameters: None
Returns:
get-campaign-details
Returns the full configuration of a campaign: name, description, owner, status, dates, milestones, check IDs, and entity filter.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Exemptions
set-exemption
Exempts a component from a specific check with a documented justification. The exemption takes effect immediately.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
remove-exemption
Removes an active exemption for a component from a specific check. If no exemption exists, the action is a no-op.
Attributes: readOnly: false · idempotent: true
Parameters
Returns:
list-exemptions
Returns all active exemptions for a component, including the check name and justification for each.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
revoke-exemption
Revokes an active exemption for a component from a specific check. The exemption record is preserved but marked as revoked, and the component becomes subject to the check again.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
restore-exemption
Restores a previously revoked exemption for a component from a specific check. The exemption becomes active again.
Attributes: readOnly: false · idempotent: false
Parameters
Returns:
list-revoked-exemptions
Returns revoked exemptions, optionally filtered by entity and/or check. Includes revocation details such as who revoked, when, and why.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Entity compliance
get-component-health
Returns overall compliance score, level, track memberships, and pass/fail check counts for a component.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
list-failing-checks
Returns all failing checks for a component, optionally filtered by track.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Facts
list-entity-facts
Returns metadata about facts collected for a given entity. Use get-fact-data to retrieve the actual value of a specific fact.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-fact-data
Returns the raw fact value for a specific fact from a specific collector for a given entity.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Org intelligence
get-org-compliance-summary
Returns a high-level overview of tech health posture across all tracks: overall score, component counts, trends, and track summaries.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-team-compliance-summary
Returns aggregated compliance scores and track breakdown for a specific team.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-top-failing-checks
Returns the checks with the highest failure rates across the org, with optional filtering.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-compliance-trends
Returns time-series compliance trend data for a track, showing per-level pass rates over the requested number of days.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
compare-teams
Returns a side-by-side compliance comparison for two or more teams, ranked by pass rate.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-rolled-up-tech-insights
Returns a track-scoped compliance overview with top and bottom performing groups, mirroring the Tech Insights Explorer page.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
find-struggling-components
Returns the components with the lowest compliance pass rates, sorted by severity. Useful for champions identifying which teams need support.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-compliance-by-level
Returns adoption metrics for a specific level within a track: component counts, percentages, and top failing components.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
Integrations
get-integration-status
Diagnoses the configuration of a Soundcheck fact collector integration: returns status, available facts, collection schedule, and any configuration errors.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
get-integration-config-schema
Returns the JSON Schema describing the configuration format for a Soundcheck integration. Use this before configure-integration to understand the required fields.
Attributes: readOnly: true · idempotent: true
Parameters
Returns:
configure-integration
Configures a Soundcheck fact collector integration with the provided settings. Use get-integration-config-schema first to understand the required configuration format.
Attributes: readOnly: false · idempotent: true
Parameters
Returns: