synq-scout health after configuring it, and
synq-scout auth login to authenticate as yourself rather than with a
client secret.
With no subcommand, Scout runs the agent.
Global flags
These apply to every command.Commands
synq-scout agent
Run the Scout agent, working tasks from Coalesce Quality
synq-scout auth
Manage Coalesce Quality API authentication
synq-scout auth login
Authenticate with Coalesce Quality in a browser
synq-scout auth logout
Remove the stored credential for a region
synq-scout auth status
Show every stored credential, for every region
synq-scout auth token
Print the access token, refreshing it if needed
synq-scout auth use
Show or set the deployment commands use by default
synq-scout auth whoami
Show who you are authenticated as and which permissions are granted
synq-scout health
Check that Scout can reach everything it needs
synq-scout issue
synq-scout mcp
Serve Scout’s tools to an MCP client over stdio
synq-scout tools.
Because stdout carries protocol frames, all logging goes to stderr.
synq-scout sre
Triage open issues once, now
synq-scout issue is the
narrower command.
synq-scout tester
Suggest data quality tests for tables
synq-scout tools
Inspect and invoke Coalesce Quality Scout MCP tools directly from the CLI
synq-scout tools add_comment
synq-scout tools apply_service_account_changes
synq-scout tools batch_entity_annotations
synq-scout tools batch_entity_details
table_metrics and table_info when they are available.
Read the size and freshness of a table there before you query it.
synq-scout tools batch_entity_marks
synq-scout tools batch_executions
synq-scout tools batch_urls
synq-scout tools browse_folders
synq-scout tools certify_entities
synq-scout tools create_incident
synq-scout tools create_monitors
synq-scout tools create_sql_tests
synq-scout tools create_table_stats_monitor
synq-scout tools decide_recommendation
synq-scout tools delete_alert
synq-scout tools delete_check_categorisation_rule
synq-scout tools delete_context_entry
synq-scout tools delete_data_product
synq-scout tools delete_deployment_rule
synq-scout tools delete_domain
synq-scout tools delete_monitors
synq-scout tools delete_owner
synq-scout tools delete_saved_view
synq-scout tools delete_sql_test_deployment_rule
synq-scout tools delete_sql_tests
synq-scout tools deploy_deployment_rule
synq-scout tools deploy_sql_test_deployment_rule
synq-scout tools deprecate_entities
synq-scout tools describe
Show a tool’s description, scopes and input/output schemas
synq-scout tools describe_check_categorisation
synq-scout tools describe_check_types
synq-scout tools describe_resolver_ql
synq-scout tools exclude_from_monitoring
synq-scout tools execute_monitor
table_metrics.num_rows of the monitored table first. If the table is
large, set a narrow time_partition_from and time_partition_to window.
synq-scout tools folder_of
folders table has every
ancestor with its own id, so you can browse or list any level directly.
To find the siblings of an entity, find its parent handle in folders.
Then pass the folder_entity_id of that entry to list_folder_members.
synq-scout tools get_alert
synq-scout tools get_code
- total_pieces larger than the length of codes: a filter or the listing cap
- content_hint on a piece: what part of the body is missing, and the call
- stored_partial: the body was cut at ingestion, and no offset reaches the
- unavailable_sources not empty: a source could not be read, so there can be
synq-scout tools get_column_usage
- its semantic role, for example measure or dimension, if it has one,
- the upstream columns that its values come from, one step up,
- the downstream columns that read its values, one step down,
- how SQL and queries use it: aggregate, group by or filter,
- the tables that it is joined with.
columns, it returns the 25 most used
columns. For the full lineage graph, use get_lineage. For the full detail
of one join, use get_join_patterns.
synq-scout tools get_commit_diff
synq-scout tools get_common_upstream_dependencies
synq-scout tools get_coverage_summary
synq-scout tools get_data_product
synq-scout tools get_database_change_details
synq-scout tools get_database_coordinates_from_entity
synq-scout tools get_deployment_rule
synq-scout tools get_domain
synq-scout tools get_downstream_dependencies
synq-scout tools get_entity_access
synq-scout tools get_entity_details
table_metrics, the latest
row count and freshness. Read it before an unbounded query on the table. It
also has table_info: the owner, creation time and size that the warehouse
reports.
synq-scout tools get_entity_from_database_coordinates
synq-scout tools get_entity_impact
synq-scout tools get_entity_knowledge
synq-scout tools get_entity_metrics
synq-scout tools get_entity_overlays
synq-scout tools get_immediate_downstream_dependencies
synq-scout tools get_immediate_upstream_dependencies
synq-scout tools get_incident_details
synq-scout tools get_issue
synq-scout tools get_issue_comments
synq-scout tools get_issue_details
synq-scout tools get_issue_impact
synq-scout tools get_join_patterns
semantic_model set.
Then come the keys that SQL definitions use, the most used first. Then
come the keys that only queries use. Only joins between known columns of
known tables are listed.
How to read a pattern:
- Put all parts of
keyin the ON clause. Each part comparescolumnof
join_typeslists how the key is joined, the most used first. Put the
- If
unique_matchis false, the join can return more rows than the
- The counts are per pattern. Do not add up the counts of patterns with
tables gives the SQL name, the row count and the unique keys of each
table. same_table_entity_ids are other ids of the same table, so do not
call again with them. To get the join between two tables, set
other_entity_id. To get the joins on one column, set column. To find
how each column of a table is used, use get_column_usage. The response is
in pages: if next_offset is set, call again with offset set to it.
synq-scout tools get_knowledge_pages
synq-scout tools get_latest_executions
synq-scout tools get_lineage
synq-scout tools get_metric_definitions
metric_name, or entity_id and field_name from search_entities or
get_semantic_model.
recommendation names a definition only by one rule. The rule is:
exactly one model is certified, with no change of the definition after
the certification, and it is not deprecated. If not, it says why Coalesce
Quality cannot choose. Do not choose for the user. The signals say what the definitions share. A
group that shares only a name may not compute the same thing. To read
what a definition computes, call get_semantic_model with field_names.
synq-scout tools get_monitor
synq-scout tools get_monitor_predictions
synq-scout tools get_owner
synq-scout tools get_query_activity
synq-scout tools get_saved_view
synq-scout tools get_schema
semantic_model is set, the entity has a semantic
model. Then use get_semantic_model for its structure and its fields. To find how SQL
uses a column, use get_column_usage. To find how to join the table, use
get_join_patterns.
synq-scout tools get_semantic_model
semantic_model, or for a
semantic view, a metric layer or a BI datasource. The model has groups of
fields. Each field has a role, for example measure, dimension or metric.
Without field_names, it returns the structure: the tables, the groups,
the fields, the joins, the AI context, the marks and the findings of the
definition. Each group lists at most fields_per_group fields. tables
reads only some tables of a large model.
With field_names, it returns only the definitions of those fields and
the findings about them. A definition has the expression, the filter, the
aggregation, the format and the steps of the computation. Use it to find
and explain what a measure or a metric computes. A mark is on the model,
not on one field. To find the other models that define a metric, call
get_metric_definitions.
synq-scout tools get_sql_test_deployment_rule
synq-scout tools get_upstream_dependencies
synq-scout tools get_upstream_sources
synq-scout tools iam
synq-scout tools list
List available MCP tools
synq-scout tools list_access_signals
synq-scout tools list_alerts
synq-scout tools list_annotations
synq-scout tools list_categorised_checks
synq-scout tools list_check_categories
synq-scout tools list_check_categorisation_rules
synq-scout tools list_checks
synq-scout tools list_commits
synq-scout tools list_context_entries
next_cursor is set, call again with cursor set to it.
synq-scout tools list_data_product_members
synq-scout tools list_data_products
synq-scout tools list_database_changes
synq-scout tools list_deployment_rules
synq-scout tools list_domain_members
synq-scout tools list_domains
synq-scout tools list_entity_coverage
synq-scout tools list_executions
synq-scout tools list_folder_members
synq-scout tools list_history
synq-scout tools list_integration_health
synq-scout tools list_knowledge_pages
synq-scout tools list_mark_history
entity_ids, it lists the changes of
those entities. If not, it lists all changes of the workspace, also the
changes of the deprecation query.
synq-scout tools list_marked_entities
by_me. The list does not include an
entity that only the deprecation query deprecates. The response gives the
deprecation query.
synq-scout tools list_monitor_segments
synq-scout tools list_monitoring_exclusions
synq-scout tools list_monitors
synq-scout tools list_open_incidents
synq-scout tools list_open_issues
synq-scout tools list_owners
synq-scout tools list_ownerships
synq-scout tools list_platform_users
synq-scout tools list_recommendations
synq-scout tools list_saved_views
synq-scout tools list_semantic_models
next_cursor is set, call again
with cursor set to it.
synq-scout tools list_service_account_suggestions
synq-scout tools list_service_accounts
synq-scout tools list_sql_test_deployment_rules
synq-scout tools list_sql_tests
synq-scout tools list_table_stats_monitors
synq-scout tools list_users
synq-scout tools plan_service_account_changes
synq-scout tools preview_check_categorisation_rule
synq-scout tools preview_deployment_rule
synq-scout tools preview_sql_test_deployment_rule
synq-scout tools profile_columns
table_metrics.num_rows from get_entity_details first. If the table is
large, set a narrow time_partition_from and time_partition_to window.
synq-scout tools remove_distinct_metrics
synq-scout tools remove_entity_marks
synq-scout tools resolve_query
synq-scout tools run_sql_test_again
synq-scout tools sample_column_values
table_metrics.num_rows from get_entity_details first. If the table is
large, set a narrow time_partition_from and time_partition_to window.
synq-scout tools sample_entities
synq-scout tools save_alert
synq-scout tools save_check_categorisation_rule
synq-scout tools save_data_product
synq-scout tools save_domain
synq-scout tools save_owner
synq-scout tools save_saved_view
synq-scout tools search_entities
table_metrics when it is available. Use it to decide if a
table is safe to query without a partition filter.
A metric or a measure of a semantic model whose name matches is in
metrics. To get its definition, call get_semantic_model with its
entity_id and field_names set to its field_name.
synq-scout tools send_test_alert
synq-scout tools set_alert_enabled
synq-scout tools set_check_category
synq-scout tools set_distinct_metrics
synq-scout tools set_issue_status
synq-scout tools set_monitor_segment_labels
synq-scout tools set_saved_view_pin
synq-scout tools submit_feature_request
synq-scout tools summarise_executions
synq-scout tools unexclude_from_monitoring
synq-scout tools update_incident
synq-scout tools update_monitors
- A reset, from a change to the schedule, time partitioning, segmentation,
- A monitor that the app or another config owns (ownership_conflicts). Show the list to the user. Call again with the ids in reset_confirmed_ids or overwrite_confirmed_ids only after the user approves.
synq-scout tools update_sql_tests
- A reset, from a change to the recurrence, severity, evaluators or
- A test that the app or another config owns (ownership_conflicts). Show the list to the user. Call again with the ids in reset_confirmed_ids or overwrite_confirmed_ids only after the user approves.
synq-scout tools update_table_stats_monitor
synq-scout tools upsert_context_entry
id, in the name of
the user. Write an entry only if the user asks. A Developer or an Admin
can write entries. If the target is a query, the entry applies after the
next computation of the query. This takes some minutes.