awslabs.cost-explorer-mcp-server 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

awslabs/cost_explorer_mcp_server/metadata_handler.py

@@ -0,0 +1,88 @@
+# 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 implementation.
+
+Metadata tools for Cost Explorer MCP Server.
+"""
+
+import os
+import sys
+from awslabs.cost_explorer_mcp_server.helpers import (
+    get_available_dimension_values,
+    get_available_tag_values,
+)
+from awslabs.cost_explorer_mcp_server.models import DateRange, DimensionKey
+from loguru import logger
+from mcp.server.fastmcp import Context
+from pydantic import Field
+from typing import Any, Dict
+
+
+# Configure Loguru logging
+logger.remove()
+logger.add(sys.stderr, level=os.getenv('FASTMCP_LOG_LEVEL', 'WARNING'))
+
+
+async def get_dimension_values(
+    ctx: Context, date_range: DateRange, dimension: DimensionKey
+) -> Dict[str, Any]:
+    """Retrieve available dimension values for AWS Cost Explorer.
+
+    This tool retrieves all available and valid values for a specified dimension (e.g., SERVICE, REGION)
+    over a period of time. This is useful for validating filter values or exploring available options
+    for cost analysis.
+
+    Args:
+        ctx: MCP context
+        date_range: The billing period start and end dates in YYYY-MM-DD format
+        dimension: The dimension key to retrieve values for (e.g., SERVICE, REGION, LINKED_ACCOUNT)
+
+    Returns:
+        Dictionary containing the dimension name and list of available values
+    """
+    try:
+        response = get_available_dimension_values(
+            dimension.dimension_key, date_range.start_date, date_range.end_date
+        )
+        return response
+    except Exception as e:
+        logger.error(f'Error getting dimension values for {dimension.dimension_key}: {e}')
+        return {'error': f'Error getting dimension values: {str(e)}'}
+
+
+async def get_tag_values(
+    ctx: Context,
+    date_range: DateRange,
+    tag_key: str = Field(..., description='The tag key to retrieve values for'),
+) -> Dict[str, Any]:
+    """Retrieve available tag values for AWS Cost Explorer.
+
+    This tool retrieves all available values for a specified tag key over a period of time.
+    This is useful for validating tag filter values or exploring available tag options for cost analysis.
+
+    Args:
+        ctx: MCP context
+        date_range: The billing period start and end dates in YYYY-MM-DD format
+        tag_key: The tag key to retrieve values for
+
+    Returns:
+        Dictionary containing the tag key and list of available values
+    """
+    try:
+        response = get_available_tag_values(tag_key, date_range.start_date, date_range.end_date)
+        return response
+    except Exception as e:
+        logger.error(f'Error getting tag values for {tag_key}: {e}')
+        return {'error': f'Error getting tag values: {str(e)}'}

awslabs/cost_explorer_mcp_server/models.py

@@ -0,0 +1,70 @@
+# 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.
+
+from awslabs.cost_explorer_mcp_server.constants import VALID_DIMENSIONS
+from awslabs.cost_explorer_mcp_server.helpers import validate_date_format, validate_date_range
+from pydantic import BaseModel, Field, field_validator
+
+
+"""Data models and validation logic for Cost Explorer MCP Server.
+"""
+
+
+class DateRange(BaseModel):
+    """Date range model for cost queries."""
+
+    start_date: str = Field(
+        description='The start date of the billing period in YYYY-MM-DD format. Defaults to last month, if not provided.'
+    )
+    end_date: str = Field(description='The end date of the billing period in YYYY-MM-DD format.')
+
+    @field_validator('start_date', 'end_date')
+    @classmethod
+    def validate_individual_dates(cls, v):
+        """Validate that individual dates are in YYYY-MM-DD format and are valid dates."""
+        is_valid, error = validate_date_format(v)
+        if not is_valid:
+            raise ValueError(error)
+        return v
+
+    def model_post_init(self, __context):
+        """Validate the date range after both dates are set."""
+        is_valid, error = validate_date_range(self.start_date, self.end_date)
+        if not is_valid:
+            raise ValueError(error)
+
+    def validate_with_granularity(self, granularity: str):
+        """Validate the date range with granularity-specific constraints."""
+        is_valid, error = validate_date_range(self.start_date, self.end_date, granularity)
+        if not is_valid:
+            raise ValueError(error)
+
+
+class DimensionKey(BaseModel):
+    """Dimension key model."""
+
+    dimension_key: str = Field(
+        description=f'The name of the dimension to retrieve values for. Valid values are {", ".join(VALID_DIMENSIONS)}.'
+    )
+
+    @field_validator('dimension_key')
+    @classmethod
+    def validate_dimension_key(cls, v):
+        """Validate that the dimension key is supported by AWS Cost Explorer."""
+        dimension_upper = v.upper()
+        if dimension_upper not in VALID_DIMENSIONS:
+            raise ValueError(
+                f"Invalid dimension key '{v}'. Valid dimensions are: {', '.join(VALID_DIMENSIONS)}"
+            )
+        return v