Docs

app.py

@@ -3,36 +3,106 @@ from camptocamp_api import CamptocampAPI
 from typing import Tuple, Optional
 
 
-# Instantiate API
+# Instantiate the Camptocamp API wrapper
 c2c = CamptocampAPI(language="en")
 
+
 def get_recent_outings(
-    west: float, south: float, east: float, north: float,
-    start_date: Optional[str], end_date: Optional[str],
-    activity: Optional[str], limit: int
-):
+    west: float,
+    south: float,
+    east: float,
+    north: float,
+    start_date: Optional[str] = None,
+    end_date: Optional[str] = None,
+    activity: Optional[str] = None,
+    limit: int = 10
+) -> dict:
+    """
+    Get recent outings near a given location and date range.
+
+    Args:
+        west: Western longitude of the bounding box.
+        south: Southern latitude of the bounding box.
+        east: Eastern longitude of the bounding box.
+        north: Northern latitude of the bounding box.
+        start_date: Start of the date range (YYYY-MM-DD).
+        end_date: End of the date range (YYYY-MM-DD).
+        activity: Optional activity filter (e.g. "hiking", "rock_climbing").
+        limit: Number of results to return.
+
+    Returns:
+        JSON dictionary of matching outings.
+    """
     bbox = (west, south, east, north)
     date_range = (start_date, end_date) if start_date and end_date else None
     return c2c.get_recent_outings(bbox, date_range, activity, limit)
 
+
 def search_routes_by_activity(
-    west: float, south: float, east: float, north: float,
-    activity: str, limit: int
-):
+    west: float,
+    south: float,
+    east: float,
+    north: float,
+    activity: str,
+    limit: int = 10
+) -> dict:
+    """
+    Search for climbing or hiking routes in a given region.
+
+    Args:
+        west: Western longitude of the bounding box.
+        south: Southern latitude of the bounding box.
+        east: Eastern longitude of the bounding box.
+        north: Northern latitude of the bounding box.
+        activity: Activity type (e.g. "rock_climbing", "hiking").
+        limit: Number of routes to return.
+
+    Returns:
+        JSON dictionary of matching route metadata.
+    """
     bbox = (west, south, east, north)
     return c2c.search_routes_by_activity(bbox, activity, limit)
 
-def get_route_details(route_id: int):
+
+def get_route_details(route_id: int) -> dict:
+    """
+    Retrieve detailed route information by route ID.
+
+    Args:
+        route_id: Unique numeric ID of the route.
+
+    Returns:
+        JSON dictionary of route information including description, grade, etc.
+    """
     return c2c.get_route_details(route_id)
 
+
 def search_waypoints(
-    west: float, south: float, east: float, north: float,
-    limit: int
-):
+    west: float,
+    south: float,
+    east: float,
+    north: float,
+    limit: int = 10
+) -> dict:
+    """
+    Get known waypoints (e.g. huts, peaks, cols) in a given area.
+
+    Args:
+        west: Western longitude of the bounding box.
+        south: Southern latitude of the bounding box.
+        east: Eastern longitude of the bounding box.
+        north: Northern latitude of the bounding box.
+        limit: Maximum number of results.
+
+    Returns:
+        JSON dictionary of waypoints.
+    """
     bbox = (west, south, east, north)
     return c2c.search_waypoints(bbox, limit)
 
 
+# ========== Gradio UI Layer ==========
+
 with gr.Blocks(title="Camptocamp API MCP") as demo:
     gr.Markdown("# 🏔️ Camptocamp API Interface")