awslabs.cost-explorer-mcp-server 0.0.2__tar.gz → 0.0.5__tar.gz

awslabs_cost_explorer_mcp_server-0.0.5/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0] - 2025-06-16
+
+### Added
+- Enhanced documentation for UsageQuantity metric with specific filtering requirements
+- Dynamic labeling for cost metrics based on grouping dimension (e.g., "Region Total" vs "Service Total")
+- Metadata support for usage metrics including grouped_by, metric type, and period information
+- Optimized JSON serialization that only runs stringify_keys when needed
+- Added Match_Option Validation
+
+### Changed
+- Usage metrics now return clean nested structure instead of complex pandas tuples
+  - Old: `{("2025-01-01", "Amount"): {"EC2": 100}, ("2025-01-01", "Unit"): {"EC2": "Hours"}}`
+  - New: `{"GroupedUsage": {"2025-01-01": {"EC2": {"amount": 100, "unit": "Hours"}}}}`
+- Improved UsageQuantity documentation to emphasize need for SERVICE + USAGE_TYPE filtering
+- Enhanced error handling for metric data processing
+
+## [0.1.0] - 2025-06-01
+
+### Added
+- Initial release of the Cost Explorer MCP Server

{awslabs_cost_explorer_mcp_server-0.0.2 → awslabs_cost_explorer_mcp_server-0.0.5}/Dockerfile

@@ -1,15 +1,18 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
-# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
-# with the License. A copy of the License is located at
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-#    http://www.apache.org/licenses/LICENSE-2.0
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
-# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
-# and limitations under the License.
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
-FROM public.ecr.aws/sam/build-python3.10@sha256:e78695db10ca8cb129e59e30f7dc9789b0dbd0181dba195d68419c72bac51ac1 AS uv
+FROM public.ecr.aws/sam/build-python3.10@sha256:d821662474d65f3cf2fc97dba2fa807a3adb580d02895fc4545527812550ea65 AS uv
 
 # Install the project into `/app`
 WORKDIR /app
@@ -43,7 +46,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
 # Make the directory just in case it doesn't exist
 RUN mkdir -p /root/.local
 
-FROM public.ecr.aws/sam/build-python3.10@sha256:e78695db10ca8cb129e59e30f7dc9789b0dbd0181dba195d68419c72bac51ac1
+FROM public.ecr.aws/sam/build-python3.10@sha256:d821662474d65f3cf2fc97dba2fa807a3adb580d02895fc4545527812550ea65
 
 # Place executables in the environment at the front of the path and include other binaries
 ENV PATH="/app/.venv/bin:$PATH:/usr/sbin"

{awslabs_cost_explorer_mcp_server-0.0.2 → awslabs_cost_explorer_mcp_server-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.cost-explorer-mcp-server
-Version: 0.0.2
+Version: 0.0.5
 Summary: MCP server for analyzing AWS costs and usage data through the AWS Cost Explorer API
 Project-URL: Homepage, https://awslabs.github.io/mcp/
 Project-URL: Documentation, https://awslabs.github.io/mcp/servers/cost-explorer-mcp-server/
@@ -22,7 +22,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: boto3>=1.36.20
-Requires-Dist: fastmcp>=0.1.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: mcp[cli]>=1.6.0
 Requires-Dist: pandas>=2.2.3
 Requires-Dist: pydantic>=2.10.6
 Description-Content-Type: text/markdown
@@ -63,6 +64,8 @@ MCP server for analyzing AWS costs and usage data through the AWS Cost Explorer
 
 ## Installation
 
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=awslabs.cost-explorer-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMuY29zdC1leHBsb3Jlci1tY3Atc2VydmVyQGxhdGVzdCIsImVudiI6eyJGQVNUTUNQX0xPR19MRVZFTCI6IkVSUk9SIiwiQVdTX1BST0ZJTEUiOiJ5b3VyLWF3cy1wcm9maWxlIn0sImRpc2FibGVkIjpmYWxzZSwiYXV0b0FwcHJvdmUiOltdfQ%3D%3D)
+
 Here are some ways you can work with MCP across AWS, and we'll be adding support to more products including Amazon Q Developer CLI soon: (e.g. for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
 
 ```json
@@ -127,6 +130,7 @@ The MCP server uses the AWS profile specified in the `AWS_PROFILE` environment v
 ```
 
 Make sure the AWS profile has permissions to access the AWS Cost Explorer API. The MCP server creates a boto3 session using the specified profile to authenticate with AWS services. Your AWS IAM credentials remain on your local machine and are strictly used for accessing AWS services.
+
 ## Cost Considerations
 
 **Important:** AWS Cost Explorer API incurs charges on a per-request basis. Each API call made by this MCP server will result in charges to your AWS account.

{awslabs_cost_explorer_mcp_server-0.0.2 → awslabs_cost_explorer_mcp_server-0.0.5}/README.md

@@ -34,6 +34,8 @@ MCP server for analyzing AWS costs and usage data through the AWS Cost Explorer
 
 ## Installation
 
+[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=awslabs.cost-explorer-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMuY29zdC1leHBsb3Jlci1tY3Atc2VydmVyQGxhdGVzdCIsImVudiI6eyJGQVNUTUNQX0xPR19MRVZFTCI6IkVSUk9SIiwiQVdTX1BST0ZJTEUiOiJ5b3VyLWF3cy1wcm9maWxlIn0sImRpc2FibGVkIjpmYWxzZSwiYXV0b0FwcHJvdmUiOltdfQ%3D%3D)
+
 Here are some ways you can work with MCP across AWS, and we'll be adding support to more products including Amazon Q Developer CLI soon: (e.g. for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
 
 ```json
@@ -98,6 +100,7 @@ The MCP server uses the AWS profile specified in the `AWS_PROFILE` environment v
 ```
 
 Make sure the AWS profile has permissions to access the AWS Cost Explorer API. The MCP server creates a boto3 session using the specified profile to authenticate with AWS services. Your AWS IAM credentials remain on your local machine and are strictly used for accessing AWS services.
+
 ## Cost Considerations
 
 **Important:** AWS Cost Explorer API incurs charges on a per-request basis. Each API call made by this MCP server will result in charges to your AWS account.

awslabs_cost_explorer_mcp_server-0.0.5/awslabs/__init__.py

@@ -0,0 +1,17 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+AWS Labs Cost Explorer MCP Server package.
+"""

awslabs_cost_explorer_mcp_server-0.0.5/awslabs/cost_explorer_mcp_server/__init__.py

@@ -0,0 +1,20 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Cost Explorer MCP Server module.
+
+This module provides MCP tools for analyzing AWS costs and usage data through the AWS Cost Explorer API.
+"""
+
+__version__ = '0.0.0'

awslabs_cost_explorer_mcp_server-0.0.5/awslabs/cost_explorer_mcp_server/helpers.py

@@ -0,0 +1,389 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Helper functions for the Cost Explorer MCP server."""
+
+import boto3
+import os
+import re
+import sys
+from datetime import datetime
+from loguru import logger
+from typing import Any, Dict, Optional, Tuple
+
+
+# Configure Loguru logging
+logger.remove()
+logger.add(sys.stderr, level=os.getenv('FASTMCP_LOG_LEVEL', 'WARNING'))
+
+# Global client cache
+_cost_explorer_client = None
+
+
+def get_cost_explorer_client():
+    """Get Cost Explorer client with proper session management and caching.
+
+    Returns:
+        boto3.client: Configured Cost Explorer client (cached after first call)
+    """
+    global _cost_explorer_client
+
+    if _cost_explorer_client is None:
+        try:
+            # Read environment variables dynamically
+            aws_region = os.environ.get('AWS_REGION', 'us-east-1')
+            aws_profile = os.environ.get('AWS_PROFILE')
+
+            if aws_profile:
+                _cost_explorer_client = boto3.Session(
+                    profile_name=aws_profile, region_name=aws_region
+                ).client('ce')
+            else:
+                _cost_explorer_client = boto3.Session(region_name=aws_region).client('ce')
+        except Exception as e:
+            logger.error(f'Error creating Cost Explorer client: {str(e)}')
+            raise
+
+    return _cost_explorer_client
+
+
+def validate_date_format(date_str: str) -> Tuple[bool, str]:
+    """Validate that a date string is in YYYY-MM-DD format and is a valid date.
+
+    Args:
+        date_str: The date string to validate
+
+    Returns:
+        Tuple of (is_valid, error_message)
+    """
+    # Check format with regex
+    if not re.match(r'^\d{4}-\d{2}-\d{2}$', date_str):
+        return False, f"Date '{date_str}' is not in YYYY-MM-DD format"
+
+    # Check if it's a valid date
+    try:
+        datetime.strptime(date_str, '%Y-%m-%d')
+        return True, ''
+    except ValueError as e:
+        return False, f"Invalid date '{date_str}': {str(e)}"
+
+
+def format_date_for_api(date_str: str, granularity: str) -> str:
+    """Format date string appropriately for AWS Cost Explorer API based on granularity.
+
+    Args:
+        date_str: Date string in YYYY-MM-DD format
+        granularity: The granularity (DAILY, MONTHLY, HOURLY)
+
+    Returns:
+        Formatted date string appropriate for the API call
+    """
+    if granularity.upper() == 'HOURLY':
+        # For hourly granularity, AWS expects datetime format
+        # Convert YYYY-MM-DD to YYYY-MM-DDTHH:MM:SSZ
+        dt = datetime.strptime(date_str, '%Y-%m-%d')
+        return dt.strftime('%Y-%m-%dT00:00:00Z')
+    else:
+        # For DAILY and MONTHLY, use the original date format
+        return date_str
+
+
+def validate_date_range(
+    start_date: str, end_date: str, granularity: Optional[str] = None
+) -> Tuple[bool, str]:
+    """Validate date range with format and logical checks.
+
+    Args:
+        start_date: The start date string in YYYY-MM-DD format
+        end_date: The end date string in YYYY-MM-DD format
+        granularity: Optional granularity to check specific constraints
+
+    Returns:
+        Tuple of (is_valid, error_message)
+    """
+    # Validate start date format
+    is_valid_start, error_start = validate_date_format(start_date)
+    if not is_valid_start:
+        return False, error_start
+
+    # Validate end date format
+    is_valid_end, error_end = validate_date_format(end_date)
+    if not is_valid_end:
+        return False, error_end
+
+    # Validate date range logic
+    start_dt = datetime.strptime(start_date, '%Y-%m-%d')
+    end_dt = datetime.strptime(end_date, '%Y-%m-%d')
+    if start_dt > end_dt:
+        return False, f"Start date '{start_date}' cannot be after end date '{end_date}'"
+
+    # Validate granularity-specific constraints
+    if granularity and granularity.upper() == 'HOURLY':
+        # HOURLY granularity supports maximum 14 days
+        date_diff = (end_dt - start_dt).days
+        if date_diff > 14:
+            return (
+                False,
+                f'HOURLY granularity supports a maximum of 14 days. Current range is {date_diff} days ({start_date} to {end_date}). Please use a shorter date range.',
+            )
+
+    return True, ''
+
+
+def get_dimension_values(
+    key: str, billing_period_start: str, billing_period_end: str
+) -> Dict[str, Any]:
+    """Get available values for a specific dimension."""
+    # Validate date range (no granularity constraint for dimension values)
+    is_valid, error_message = validate_date_range(billing_period_start, billing_period_end)
+    if not is_valid:
+        return {'error': error_message}
+
+    try:
+        ce = get_cost_explorer_client()
+        response = ce.get_dimension_values(
+            TimePeriod={'Start': billing_period_start, 'End': billing_period_end},
+            Dimension=key.upper(),
+        )
+        dimension_values = response['DimensionValues']
+        values = [value['Value'] for value in dimension_values]
+        return {'dimension': key.upper(), 'values': values}
+    except Exception as e:
+        logger.error(
+            f'Error getting dimension values for {key.upper()} ({billing_period_start} to {billing_period_end}): {e}'
+        )
+        return {'error': str(e)}
+
+
+def get_tag_values(
+    tag_key: str, billing_period_start: str, billing_period_end: str
+) -> Dict[str, Any]:
+    """Get available values for a specific tag key."""
+    # Validate date range (no granularity constraint for tag values)
+    is_valid, error_message = validate_date_range(billing_period_start, billing_period_end)
+    if not is_valid:
+        return {'error': error_message}
+
+    try:
+        ce = get_cost_explorer_client()
+        response = ce.get_tags(
+            TimePeriod={'Start': billing_period_start, 'End': billing_period_end},
+            TagKey=tag_key,
+        )
+        tag_values = response['Tags']
+        return {'tag_key': tag_key, 'values': tag_values}
+    except Exception as e:
+        logger.error(
+            f'Error getting tag values for {tag_key} ({billing_period_start} to {billing_period_end}): {e}'
+        )
+        return {'error': str(e)}
+
+
+def validate_match_options(match_options: list, filter_type: str) -> Dict[str, Any]:
+    """Validate MatchOptions based on filter type.
+
+    Args:
+        match_options: List of match options to validate
+        filter_type: Type of filter ('Dimensions', 'Tags', 'CostCategories')
+
+    Returns:
+        Empty dictionary if valid, or an error dictionary
+    """
+    if filter_type == 'Dimensions':
+        valid_options = ['EQUALS', 'CASE_SENSITIVE']
+    elif filter_type in ['Tags', 'CostCategories']:
+        valid_options = ['EQUALS', 'ABSENT', 'CASE_SENSITIVE']
+    else:
+        return {'error': f'Unknown filter type: {filter_type}'}
+
+    for option in match_options:
+        if option not in valid_options:
+            return {
+                'error': f"Invalid MatchOption '{option}' for {filter_type}. Valid values are: {valid_options}"
+            }
+
+    return {}
+
+
+def validate_expression(
+    expression: Dict[str, Any], billing_period_start: str, billing_period_end: str
+) -> Dict[str, Any]:
+    """Recursively validate the filter expression.
+
+    Args:
+        expression: The filter expression to validate
+        billing_period_start: Start date of the billing period
+        billing_period_end: End date of the billing period
+
+    Returns:
+        Empty dictionary if valid, or an error dictionary
+    """
+    # Validate date range (no granularity constraint for filter validation)
+    is_valid, error_message = validate_date_range(billing_period_start, billing_period_end)
+    if not is_valid:
+        return {'error': error_message}
+
+    try:
+        if 'Dimensions' in expression:
+            dimension = expression['Dimensions']
+            if (
+                'Key' not in dimension
+                or 'Values' not in dimension
+                or 'MatchOptions' not in dimension
+            ):
+                return {
+                    'error': 'Dimensions filter must include "Key", "Values", and "MatchOptions".'
+                }
+
+            # Validate MatchOptions for Dimensions
+            match_options_result = validate_match_options(dimension['MatchOptions'], 'Dimensions')
+            if 'error' in match_options_result:
+                return match_options_result
+
+            dimension_key = dimension['Key']
+            dimension_values = dimension['Values']
+            valid_values_response = get_dimension_values(
+                dimension_key, billing_period_start, billing_period_end
+            )
+            if 'error' in valid_values_response:
+                return {'error': valid_values_response['error']}
+            valid_values = valid_values_response['values']
+            for value in dimension_values:
+                if value not in valid_values:
+                    return {
+                        'error': f"Invalid value '{value}' for dimension '{dimension_key}'. Valid values are: {valid_values}"
+                    }
+
+        if 'Tags' in expression:
+            tag = expression['Tags']
+            if 'Key' not in tag or 'Values' not in tag or 'MatchOptions' not in tag:
+                return {'error': 'Tags filter must include "Key", "Values", and "MatchOptions".'}
+
+            # Validate MatchOptions for Tags
+            match_options_result = validate_match_options(tag['MatchOptions'], 'Tags')
+            if 'error' in match_options_result:
+                return match_options_result
+
+            tag_key = tag['Key']
+            tag_values = tag['Values']
+            valid_tag_values_response = get_tag_values(
+                tag_key, billing_period_start, billing_period_end
+            )
+            if 'error' in valid_tag_values_response:
+                return {'error': valid_tag_values_response['error']}
+            valid_tag_values = valid_tag_values_response['values']
+            for value in tag_values:
+                if value not in valid_tag_values:
+                    return {
+                        'error': f"Invalid value '{value}' for tag '{tag_key}'. Valid values are: {valid_tag_values}"
+                    }
+
+        if 'CostCategories' in expression:
+            cost_category = expression['CostCategories']
+            if (
+                'Key' not in cost_category
+                or 'Values' not in cost_category
+                or 'MatchOptions' not in cost_category
+            ):
+                return {
+                    'error': 'CostCategories filter must include "Key", "Values", and "MatchOptions".'
+                }
+
+            # Validate MatchOptions for CostCategories
+            match_options_result = validate_match_options(
+                cost_category['MatchOptions'], 'CostCategories'
+            )
+            if 'error' in match_options_result:
+                return match_options_result
+
+        logical_operators = ['And', 'Or', 'Not']
+        logical_count = sum(1 for op in logical_operators if op in expression)
+
+        if logical_count > 1:
+            return {
+                'error': 'Only one logical operator (And, Or, Not) is allowed per expression in filter parameter.'
+            }
+
+        if logical_count == 0 and len(expression) > 1:
+            return {
+                'error': 'Filter parameter with multiple expressions require a logical operator (And, Or, Not).'
+            }
+
+        if 'And' in expression:
+            if not isinstance(expression['And'], list):
+                return {'error': 'And expression must be a list of expressions.'}
+            for sub_expression in expression['And']:
+                result = validate_expression(
+                    sub_expression, billing_period_start, billing_period_end
+                )
+                if 'error' in result:
+                    return result
+
+        if 'Or' in expression:
+            if not isinstance(expression['Or'], list):
+                return {'error': 'Or expression must be a list of expressions.'}
+            for sub_expression in expression['Or']:
+                result = validate_expression(
+                    sub_expression, billing_period_start, billing_period_end
+                )
+                if 'error' in result:
+                    return result
+
+        if 'Not' in expression:
+            if not isinstance(expression['Not'], dict):
+                return {'error': 'Not expression must be a single expression.'}
+            result = validate_expression(
+                expression['Not'], billing_period_start, billing_period_end
+            )
+            if 'error' in result:
+                return result
+
+        if not any(
+            k in expression for k in ['Dimensions', 'Tags', 'CostCategories', 'And', 'Or', 'Not']
+        ):
+            return {
+                'error': 'Filter Expression must include at least one of the following keys: "Dimensions", "Tags", "CostCategories", "And", "Or", "Not".'
+            }
+
+        return {}
+    except Exception as e:
+        return {'error': f'Error validating expression: {str(e)}'}
+
+
+def validate_group_by(group_by: Optional[Dict[str, Any]]) -> Dict[str, Any]:
+    """Validate the group_by parameter.
+
+    Args:
+        group_by: The group_by dictionary to validate
+
+    Returns:
+        Empty dictionary if valid, or an error dictionary
+    """
+    try:
+        if (
+            group_by is None
+            or not isinstance(group_by, dict)
+            or 'Type' not in group_by
+            or 'Key' not in group_by
+        ):
+            return {'error': 'group_by must be a dictionary with "Type" and "Key" keys.'}
+
+        if group_by['Type'].upper() not in ['DIMENSION', 'TAG', 'COST_CATEGORY']:
+            return {
+                'error': 'Invalid group Type. Valid types are DIMENSION, TAG, and COST_CATEGORY.'
+            }
+
+        return {}
+    except Exception as e:
+        return {'error': f'Error validating group_by: {str(e)}'}