Version 4.43 or later needs to be installed to add the server automatically
Use cases
About
Industrial IoT asset management.
| Attribute | Details |
|---|---|
| Docker Image | mcp/aws-iot-sitewise-mcp-server |
| Author | awslabs |
| Repository | https://github.com/awslabs/mcp |
| Attribute | Details |
|---|---|
| Dockerfile | https://github.com/awslabs/mcp/blob/636aca8e109b5559006044f035bb89c16e9e5410/src/aws-iot-sitewise-mcp-server/Dockerfile |
| Commit | 636aca8e109b5559006044f035bb89c16e9e5410 |
| Docker Image built by | Docker Inc. |
| Docker Scout Health Score | |
| Verify Signature | COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/aws-iot-sitewise-mcp-server --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub |
| Licence | Apache License 2.0 |
| Tools provided by this Server | Short Description |
|---|---|
batch_get_asset_property_aggregates | Get aggregated values for multiple asset properties. |
batch_get_asset_property_value | Get the current values for multiple asset properties. |
batch_get_asset_property_value_hist | Get the historical values for multiple asset properties. |
convert_multiple_timestamps | Convert multiple Unix epoch timestamps to human-readable format. |
convert_unix_timestamp | Convert Unix epoch timestamp to human-readable format. |
create_bulk_import_schema | Construct and validate a bulk import schema. |
create_timestamp_range | Create a formatted timestamp range from start and end timestamps. |
describe_action | Describe an action in AWS IoT SiteWise. |
describe_asset | Retrieve information about an asset. |
describe_asset_model | Retrieve information about an asset model. |
describe_bulk_import_job | Get detailed information about a specific bulk import job in AWS IoT SiteWise. |
describe_computation_model | Describe a computation model in AWS IoT SiteWise. |
describe_computation_model_execution_summary | Describe a computation model execution summary in AWS IoT SiteWise. |
describe_default_encryption_config | Retrieve information about the default encryption configuration for your AWS account. |
describe_execution | Describe an execution in AWS IoT SiteWise. |
describe_gateway | Retrieve information about a gateway. |
describe_gateway_capability_config | Retrieve information about a gateway capability configuration. |
describe_logging_options | Retrieve the current AWS IoT SiteWise logging options. |
describe_storage_configuration | Retrieve information about the storage configuration for your AWS account. |
describe_time_series | Retrieve information about a time series (data stream). |
execute_query | Execute comprehensive SQL queries against AWS IoT SiteWise data using the executeQuery API. |
get_asset_property_aggregates | Get aggregated values for an asset property. |
get_asset_property_value | Get the current value for the given asset property. |
get_asset_property_value_history | Get the history of an asset property's values. |
get_current_timestamp | Get the current Unix timestamp and formatted time. |
get_interpl_asset_property_values | Get interpolated values for an asset property for a specified time interval. |
get_metadata_transfer_job | Get details of a metadata transfer job. |
get_sitewise_server_mode | Get the current SiteWise server mode and available capabilities. |
list_actions | List actions for a specific target resource in AWS IoT SiteWise. |
list_asset_model_properties | Retrieve a paginated list of properties associated with an asset model. |
list_asset_models | Retrieve a paginated list of summaries for all asset models. |
list_assets | Retrieve a paginated list of asset summaries. |
list_associated_assets | Retrieve a paginated list of associated assets. |
list_bulk_import_jobs | List bulk import jobs in AWS IoT SiteWise. |
list_computation_model_data_binding_usages | Find computation models that use a given resource in data binding. |
list_computation_model_resolve_to_resources | List computation model resolve to resources in AWS IoT SiteWise. |
list_computation_models | List computation models in AWS IoT SiteWise. |
list_executions | List executions for a specific target resource in AWS IoT SiteWise. |
list_gateways | Retrieve a paginated list of gateways. |
list_metadata_transfer_jobs | List metadata transfer jobs. |
list_time_series | Retrieve a paginated list of time series (data streams). |
batch_get_asset_property_aggregatesGet aggregated values for multiple asset properties.
| Parameters | Type | Description |
|---|---|---|
entries | array | The list of asset property aggregate entries for the batch get request |
max_results | integeroptional | The maximum number of results to return (1-4000) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
batch_get_asset_property_valueGet the current values for multiple asset properties.
| Parameters | Type | Description |
|---|---|---|
entries | array | The list of asset property identifiers for the batch get request |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
batch_get_asset_property_value_histGet the historical values for multiple asset properties.
| Parameters | Type | Description |
|---|---|---|
entries | array | The list of asset property historical value entries for the batch get request |
max_results | integeroptional | The maximum number of results to return (1-4000) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
convert_multiple_timestampsConvert multiple Unix epoch timestamps to human-readable format.
This tool converts multiple timestamps at once, useful for processing API responses that contain several timestamp fields.
| Parameters | Type | Description |
|---|---|---|
timestamps | object | Dictionary of timestamp names and values |
format_string | stringoptional | Python strftime format string for output formatting |
convert_unix_timestampConvert Unix epoch timestamp to human-readable format.
This tool provides accurate timestamp conversion to prevent AI agents from making conversion errors when interpreting Unix timestamps from API responses.
| Parameters | Type | Description |
|---|---|---|
timestamp | string | Unix epoch timestamp (seconds since 1970-01-01) |
format_string | stringoptional | Python strftime format string for output formatting |
timezone | stringoptional | Timezone for conversion (currently only supports UTC) |
create_bulk_import_schemaConstruct and validate a bulk import schema.
| Parameters | Type | Description |
|---|---|---|
asset_models | stringoptional | List of asset model definitions. Each must include: |
assets | stringoptional | List of asset definitions. Each must include: |
create_timestamp_rangeCreate a formatted timestamp range from start and end timestamps.
This tool formats a range of timestamps for display, useful for showing training periods, evaluation periods, or other time ranges.
| Parameters | Type | Description |
|---|---|---|
end_timestamp | string | End Unix epoch timestamp |
start_timestamp | string | Start Unix epoch timestamp |
format_string | stringoptional | Python strftime format string for output formatting |
describe_actionDescribe an action in AWS IoT SiteWise.
Retrieves detailed information about a specific action, including its definition, payload, target resource, execution time, and resolution details.
| Parameters | Type | Description |
|---|---|---|
action_id | string | The ID of the action to describe (required) |
region | stringoptional | AWS region (default: us-east-1) |
describe_assetRetrieve information about an asset.
| Parameters | Type | Description |
|---|---|---|
asset_id | string | The ID of the asset (UUID format: 12345678-1234-1234-1234-123456789012 or external ID format: externalId:my-external-id) |
exclude_properties | booleanoptional | Whether to exclude asset properties from the response |
region | stringoptional | AWS region |
describe_asset_modelRetrieve information about an asset model.
| Parameters | Type | Description |
|---|---|---|
asset_model_id | string | The ID of the asset model (UUID format: 12345678-1234-1234-1234-123456789012 or external ID format: externalId:my-external-id) |
asset_model_version | stringoptional | The version of the asset model (LATEST, ACTIVE) |
exclude_properties | booleanoptional | Whether to exclude asset model properties |
region | stringoptional | AWS region |
describe_bulk_import_jobGet detailed information about a specific bulk import job in AWS IoT SiteWise.
This function retrieves comprehensive details about a bulk import job including its configuration, status, progress, error information, and execution statistics.
| Parameters | Type | Description |
|---|---|---|
job_id | string | The ID of the bulk import job to describe (UUID format) |
region | stringoptional | AWS region |
describe_computation_modelDescribe a computation model in AWS IoT SiteWise.
Retrieves detailed information about a specific computation model, including its configuration, data bindings, status, and metadata.
| Parameters | Type | Description |
|---|---|---|
computation_model_id | string | The ID of the computation model to describe (required, must be in UUID format) |
computation_model_version | stringoptional | Optional version of the computation model |
region | stringoptional | AWS region (default: us-east-1) |
describe_computation_model_execution_summaryDescribe a computation model execution summary in AWS IoT SiteWise.
This tool intelligently determines whether to use resolve parameters based on the computation model configuration:
Smart Optimization: If you know the configuration type, provide it via the configuration_type
parameter to avoid an additional API call to describe_computation_model for type detection.
| Parameters | Type | Description |
|---|---|---|
computation_model_id | string | The ID of the computation model (required, must be in UUID format) |
configuration_type | stringoptional | Optional configuration type hint to avoid auto-detection API call. |
region | stringoptional | AWS region (default: us-east-1) |
resolve_to_resource_id | stringoptional | Optional ID of the resolved resource (only used for asset model level configurations) |
resolve_to_resource_type | stringoptional | Optional type of the resolved resource (ASSET, only used for asset model level configurations) |
describe_default_encryption_configRetrieve information about the default encryption configuration for your AWS account.
| Parameters | Type | Description |
|---|---|---|
region | stringoptional | AWS region |
describe_executionDescribe an execution in AWS IoT SiteWise.
Retrieves detailed information about a specific execution, including execution details, status, timestamps, target resource information, and execution results. This provides comprehensive information about the execution process.
| Parameters | Type | Description |
|---|---|---|
execution_id | string | The ID of the execution to describe (required) |
region | stringoptional | AWS region (default: us-east-1) |
describe_gatewayRetrieve information about a gateway.
| Parameters | Type | Description |
|---|---|---|
gateway_id | string | The ID of the gateway device |
region | stringoptional | AWS region |
describe_gateway_capability_configRetrieve information about a gateway capability configuration.
| Parameters | Type | Description |
|---|---|---|
capability_namespace | string | The namespace of the capability configuration |
gateway_id | string | The ID of the gateway that defines the capability configuration |
region | stringoptional | AWS region |
describe_logging_optionsRetrieve the current AWS IoT SiteWise logging options.
| Parameters | Type | Description |
|---|---|---|
region | stringoptional | AWS region |
describe_storage_configurationRetrieve information about the storage configuration for your AWS account.
| Parameters | Type | Description |
|---|---|---|
region | stringoptional | AWS region |
describe_time_seriesRetrieve information about a time series (data stream).
| Parameters | Type | Description |
|---|---|---|
alias | stringoptional | The alias that identifies the time series |
asset_id | stringoptional | The ID of the asset in which the asset property was created |
property_id | stringoptional | The ID of the asset property |
region | stringoptional | AWS region |
execute_queryExecute comprehensive SQL queries against AWS IoT SiteWise data using the executeQuery API.
The AWS IoT SiteWise query language supports SQL capabilities including:
Available Views and Schema (From Official AWS Documentation):
ASSET VIEW: Contains information about the asset and model derivation
ASSET_PROPERTY VIEW: Contains information about the asset property's structure
RAW_TIME_SERIES VIEW: Contains the historical data of the time series
LATEST_VALUE_TIME_SERIES VIEW: Contains the latest value of the time series
PRECOMPUTED_AGGREGATES VIEW: Contains automatically computed aggregated asset property values
Complete SQL Function Reference (From AWS IoT SiteWise User Guide):
DATE/TIME FUNCTIONS:
Note: NOW() IS supported. When doing math on NOW() or any timestamp, use TIMESTAMP_ADD/TIMESTAMP_SUB functions rather than +/- operators.
TYPE CONVERSION FUNCTIONS:
AGGREGATE FUNCTIONS:
IMPORTANT LIMITATIONS:
SUPPORTED FEATURES:
query_statement|string|SQL query statement to execute against AWS IoT SiteWise data
max_results|integeroptional|The maximum number of results to return (1-10000)
next_token|stringoptional|The token to be used for the next set of paginated results
region|stringoptional|AWS regionget_asset_property_aggregatesGet aggregated values for an asset property.
| Parameters | Type | Description |
|---|---|---|
aggregate_types | stringoptional | The data aggregating function (AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION) |
asset_id | stringoptional | The ID of the asset |
end_date | stringoptional | The inclusive end of the range (ISO 8601 format) |
max_results | integeroptional | The maximum number of results to return (1-4000) |
next_token | stringoptional | The token to be used for the next set of paginated results |
property_alias | stringoptional | The alias that identifies the property |
property_id | stringoptional | The ID of the asset property |
qualities | stringoptional | The quality by which to filter asset data (GOOD, BAD, UNCERTAIN) |
region | stringoptional | AWS region |
resolution | stringoptional | The time interval over which to aggregate data |
start_date | stringoptional | The exclusive start of the range (ISO 8601 format) |
time_ordering | stringoptional | The chronological sorting order (ASCENDING, DESCENDING) |
get_asset_property_valueGet the current value for the given asset property.
| Parameters | Type | Description |
|---|---|---|
asset_id | stringoptional | The ID of the asset |
property_alias | stringoptional | The alias that identifies the property |
property_id | stringoptional | The ID of the asset property |
region | stringoptional | AWS region |
get_asset_property_value_historyGet the history of an asset property's values.
| Parameters | Type | Description |
|---|---|---|
asset_id | stringoptional | The ID of the asset |
end_date | stringoptional | The inclusive end of the range (ISO 8601 format) |
max_results | integeroptional | The maximum number of results to return (1-4000) |
next_token | stringoptional | The token to be used for the next set of paginated results |
property_alias | stringoptional | The alias that identifies the property |
property_id | stringoptional | The ID of the asset property |
qualities | stringoptional | The quality by which to filter asset data (GOOD, BAD, UNCERTAIN) |
region | stringoptional | AWS region |
start_date | stringoptional | The exclusive start of the range (ISO 8601 format) |
time_ordering | stringoptional | The chronological sorting order (ASCENDING, DESCENDING) |
get_current_timestampGet the current Unix timestamp and formatted time.
This tool provides the current timestamp in both Unix epoch format and human-readable format, useful for reference when working with timestamps.
Returns: Dictionary containing current timestamp information
get_interpl_asset_property_valuesGet interpolated values for an asset property for a specified time interval.
| Parameters | Type | Description |
|---|---|---|
asset_id | stringoptional | The ID of the asset |
end_time_in_seconds | stringoptional | The inclusive end of the range (Unix epoch time in seconds) |
interpolation_type | stringoptional | The interpolation type (LINEAR_INTERPOLATION, LOCF_INTERPOLATION) |
interval_in_seconds | integeroptional | The time interval in seconds over which to interpolate data |
interval_window_in_seconds | stringoptional | The query interval for interpolated values |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
property_alias | stringoptional | The alias that identifies the property |
property_id | stringoptional | The ID of the asset property |
quality | stringoptional | The quality of the asset property value (GOOD, BAD, UNCERTAIN) |
region | stringoptional | AWS region |
start_time_in_seconds | stringoptional | The exclusive start of the range (Unix epoch time in seconds) |
get_metadata_transfer_jobGet details of a metadata transfer job.
| Parameters | Type | Description |
|---|---|---|
metadata_transfer_job_id | string | The metadata transfer job ID to retrieve |
region | stringoptional | AWS region |
get_sitewise_server_modeGet the current SiteWise server mode and available capabilities.
This tool helps users understand what operations are available and provides guidance for enabling write operations if needed.
Returns: Dictionary containing server mode information and capabilities
list_actionsList actions for a specific target resource in AWS IoT SiteWise.
Retrieves a paginated list of actions associated with a specific target resource. You can filter by resolved resource and control pagination.
| Parameters | Type | Description |
|---|---|---|
target_resource_id | string | The ID of the target resource (required) |
target_resource_type | string | The type of resource - ASSET or COMPUTATION_MODEL (required) |
max_results | stringoptional | Optional maximum number of results to return (1-250) |
next_token | stringoptional | Optional token for pagination to get the next set of results |
region | stringoptional | AWS region (default: us-east-1) |
resolve_to_resource_id | stringoptional | Optional ID of the resolved resource |
resolve_to_resource_type | stringoptional | Optional type of the resolved resource (ASSET) |
list_asset_model_propertiesRetrieve a paginated list of properties associated with an asset model.
| Parameters | Type | Description |
|---|---|---|
asset_model_id | string | The ID of the asset model (UUID format: 12345678-1234-1234-1234-123456789012 or external ID format: externalId:my-external-id) |
asset_model_version | stringoptional | The version of the asset model (LATEST, ACTIVE) |
filter_type | stringoptional | Filter properties by type (ALL, BASE) |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
list_asset_modelsRetrieve a paginated list of summaries for all asset models.
| Parameters | Type | Description |
|---|---|---|
asset_model_types | stringoptional | The type of asset model (ASSET_MODEL, COMPONENT_MODEL) |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
list_assetsRetrieve a paginated list of asset summaries.
| Parameters | Type | Description |
|---|---|---|
asset_model_id | stringoptional | The ID of the asset model by which to filter the list of assets |
filter_type | stringoptional | Filter assets by ALL or TOP_LEVEL |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
list_associated_assetsRetrieve a paginated list of associated assets.
| Parameters | Type | Description |
|---|---|---|
asset_id | string | The ID of the asset to query (UUID format: 12345678-1234-1234-1234-123456789012 or external ID format: externalId:my-external-id) |
hierarchy_id | stringoptional | The ID of the hierarchy by which child assets are associated |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
traversal_direction | stringoptional | The direction to list associated assets (PARENT, CHILD) |
list_bulk_import_jobsList bulk import jobs in AWS IoT SiteWise.
This function retrieves a paginated list of bulk import job summaries with optional filtering by job status. Each job summary includes basic information like job ID, name, status, and timestamps.
| Parameters | Type | Description |
|---|---|---|
filter | stringoptional | Filter to apply to the list of bulk import jobs. Valid values: ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
list_computation_model_data_binding_usagesFind computation models that use a given resource in data binding.
This API helps you find computation models which are bound to a given resource:
data_binding_value_filter|object|Filter to specify which resource to search for (required)
max_results|stringoptional|Optional maximum number of results to return (1-250)
next_token|stringoptional|Optional token for pagination to get the next set of results
region|stringoptional|AWS region (default: us-east-1)list_computation_model_resolve_to_resourcesList computation model resolve to resources in AWS IoT SiteWise.
Retrieves a paginated list of resources that a computation model resolves to. This shows the specific assets or other resources that are associated with the computation model through resolve-to relationships.
| Parameters | Type | Description |
|---|---|---|
computation_model_id | string | The ID of the computation model (required, must be in UUID format) |
max_results | stringoptional | Optional maximum number of results to return (1-250) |
next_token | stringoptional | Optional token for pagination to get the next set of results |
region | stringoptional | AWS region (default: us-east-1) |
list_computation_modelsList computation models in AWS IoT SiteWise.
Retrieves a paginated list of computation models in your AWS account. You can filter by computation model type and control pagination.
| Parameters | Type | Description |
|---|---|---|
computation_model_type | stringoptional | Optional filter by computation model type (e.g., 'ANOMALY_DETECTION') |
max_results | stringoptional | Optional maximum number of results to return (1-250, default: AWS default) |
next_token | stringoptional | Optional token for pagination to get the next set of results |
region | stringoptional | AWS region (default: us-east-1) |
list_executionsList executions for a specific target resource in AWS IoT SiteWise.
Retrieves a paginated list of executions that occurred after performing execute actions on the specified target resource. This shows the progress status, error information, and execution details for training actions, inference schedules, and other action types.
| Parameters | Type | Description |
|---|---|---|
target_resource_id | string | The ID of the target resource to list executions for (required, must be in UUID format) |
target_resource_type | string | The type of resource - ASSET or COMPUTATION_MODEL (required) |
action_type | stringoptional | Optional type of action executed to filter results |
max_results | stringoptional | Optional maximum number of results to return (1-250) |
next_token | stringoptional | Optional token for pagination to get the next set of results |
region | stringoptional | AWS region (default: us-east-1) |
resolve_to_resource_id | stringoptional | Optional ID of the resolved resource |
resolve_to_resource_type | stringoptional | Optional type of the resolved resource (ASSET) |
list_gatewaysRetrieve a paginated list of gateways.
| Parameters | Type | Description |
|---|---|---|
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
list_metadata_transfer_jobsList metadata transfer jobs.
| Parameters | Type | Description |
|---|---|---|
destination_type | string | Filter by destination type (s3, iotsitewise) - REQUIRED |
source_type | string | Filter by source type (s3, iotsitewise) - REQUIRED |
max_results | integeroptional | Maximum number of results to return (1-200) |
next_token | stringoptional | Token for pagination |
region | stringoptional | AWS region |
list_time_seriesRetrieve a paginated list of time series (data streams).
| Parameters | Type | Description |
|---|---|---|
alias_prefix | stringoptional | The alias prefix of the time series |
asset_id | stringoptional | The ID of the asset in which the asset property was created |
max_results | integeroptional | The maximum number of results to return (1-250) |
next_token | stringoptional | The token to be used for the next set of paginated results |
region | stringoptional | AWS region |
time_series_type | stringoptional | The type of the time series (ASSOCIATED, DISASSOCIATED) |
{
"mcpServers": {
"aws-iot-sitewise": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"AWS_REGION",
"-e",
"AWS_PROFILE",
"mcp/aws-iot-sitewise-mcp-server"
],
"env": {
"AWS_REGION": "us-east-1",
"AWS_PROFILE": "default"
}
}
}
}