feat!: embed hints in tool descriptions (#18)

BREAKING CHANGE: removes all of the `*_hints` MCP tools and instead
moves hints to the dynamically generated `description` for the
`run_report` and `run_realtime_report` tools.

Author: jradcliff

README.md

@@ -23,29 +23,14 @@ to provide several
 
 ### Run core reports :orange_book:
 
-- `run_report`: Run a Google Analytics report using the Data API.
-- `get_dimensions`: Retrieves Core Reporting Dimensions for a specific
-  property, including its custom dimensions.
-- `get_metrics`: Retrieves Core Reporting Metrics for a specific property,
-  including its custom dimensions.
-- `get_standard_dimensions`: Returns a list of standard dimensions.
-- `get_standard_metrics`: Returns a list of standard metrics.
-- `run_report_date_ranges_hints`: Provides hints about the expected values
-  for the `date_ranges` argument for the `run_report` tool.
-- `run_report_metric_filter_hints`: Provides hints about the expected values
-  for the metric_filter argument for the `run_report` and
-  `run_realtime_report` tools.
-- `run_report_dimension_filter_hints`: Provides hints about the expected
-  values for the dimension_filter argument for the `run_report` and
-  `run_realtime_report` tools.
+- `run_report`: Runs a Google Analytics report using the Data API.
+- `get_custom_dimensions_and_metrics`: Retrieves the custom dimensions and
+  metrics for a specific property.
 
 ### Run realtime reports :hourglass_flowing_sand:
 
-- `run_realtime_report`: Run a Google Analytics realtime report using the
+- `run_realtime_report`: Runs a Google Analytics realtime report using the
   Data API.
-- `get_realtime_dimensions`: Retrieves the list of realtime reporting
-  dimensions.
-- `get_realtime_metrics`: Retrieves the list of realtime metrics.
 
 ## Setup instructions
 

analytics_mcp/tools/admin/info.py

@@ -18,6 +18,7 @@
 
 from analytics_mcp.coordinator import mcp
 from analytics_mcp.tools.utils import (
+    construct_property_rn,
     create_admin_api_client,
     proto_to_dict,
 )
@@ -38,15 +39,16 @@ async def get_account_summaries() -> List[Dict[str, Any]]:
 
 
 @mcp.tool(title="List links to Google Ads accounts")
-async def list_google_ads_links(property_id: str) -> List[Dict[str, Any]]:
+async def list_google_ads_links(property_id: int | str) -> List[Dict[str, Any]]:
     """Returns a list of links to Google Ads accounts for a property.
 
     Args:
-        property_id: The ID of the property.
+        property_id: The Google Analytics property ID. Accepted formats are:
+          - A number
+          - A string consisting of 'properties/' followed by a number
     """
-    property_resource_name = f"properties/{property_id}"
     request = admin_v1beta.ListGoogleAdsLinksRequest(
-        parent=property_resource_name
+        parent=construct_property_rn(property_id)
     )
     # Uses an async list comprehension so the pager returned by
     # list_google_ads_links retrieves all pages.
@@ -58,13 +60,16 @@ async def list_google_ads_links(property_id: str) -> List[Dict[str, Any]]:
 
 
 @mcp.tool(title="Gets details about a property")
-def get_property_details(property_id: str) -> Dict[str, Any]:
+def get_property_details(property_id: int | str) -> Dict[str, Any]:
     """Returns details about a property.
     Args:
-        property_id: The ID of the property.
+        property_id: The Google Analytics property ID. Accepted formats are:
+          - A number
+          - A string consisting of 'properties/' followed by a number
     """
     client = admin_v1beta.AnalyticsAdminServiceClient()
-    property_resource_name = f"properties/{property_id}"
-    request = admin_v1beta.GetPropertyRequest(name=property_resource_name)
+    request = admin_v1beta.GetPropertyRequest(
+        name=construct_property_rn(property_id)
+    )
     response = client.get_property(request=request)
     return proto_to_dict(response)