Skip to main content

MCP surf project

Project description

Surf MCP Server

MCP server for people who surf waves and the web.

Diagram

Letter Dot Grid - 5 dpi

Video Demo

https://github.com/user-attachments/assets/0a4453e2-66df-4bf5-8366-8538cda366ed

Features

  • Fetch tide information for any location using latitude and longitude
  • Support for date-specific tide queries
  • Detailed tide data including high/low tides and station information
  • Automatic time zone handling (UTC)

Prerequisites

  • Python 3.x
  • Storm Glass API key

Getting Your Storm Glass API Key

  1. Visit Storm Glass
  2. Click "Try for Free" or "Sign In" to create an account
  3. Once registered, you'll receive your API key

Note on API Usage Limits:

  • Free tier: 10 requests per day
  • Paid plans available:
    • Small: 500 requests/day (€19/month)
    • Medium: 5000 requests/day (€49/month)
    • Large: 25,000 requests/day (€129/month)
    • Enterprise: Custom plans available

Choose a plan based on your usage requirements. The free tier is suitable for testing and personal use.

Installation

  1. Clone the repository:
git clone https://github.com/ravinahp/surf-mcp.git
cd surf-mcp
  1. Install dependencies using uv:
uv sync

Note: We use uv instead of pip since the project uses pyproject.toml for dependency management.

Configure as MCP Server

To add this tool as an MCP server, you'll need to modify your Claude desktop configuration file. This configuration includes your Storm Glass API key, so you won't need to set it up separately.

The configuration file location depends on your operating system:

  • MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json

Add the following configuration to your JSON file:

{
    "surf-mcp": {
        "command": "uv",
        "args": [
            "--directory",
            "/Users/YOUR_USERNAME/Code/surf-mcp",
            "run",
            "surf-mcp"
        ],
        "env": {
            "STORMGLASS_API_KEY": "your_api_key_here"
        }
    }
}

⚠️ IMPORTANT:

  1. Replace YOUR_USERNAME with your actual system username
  2. Replace your_api_key_here with your actual Storm Glass API key
  3. Make sure the directory path matches your local installation

Deployment

Building

To prepare the package:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package:
uv build

This will create distributions in the dist/ directory.

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector with this command:

npx @modelcontextprotocol/inspector uv --directory /path/to/surf-mcp run surf-mcp

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

The Inspector provides:

  • Real-time request/response monitoring
  • Input/output validation
  • Error tracking
  • Performance metrics

Usage

The service provides a FastMCP tool for getting tide information:

@mcp.tool()
async def get_tides(latitude: float, longitude: float, date: str) -> str:
    """Get tide information for a specific location and date."""

Parameters:

  • latitude: Float value representing the location's latitude
  • longitude: Float value representing the location's longitude
  • date: Date string in YYYY-MM-DD format

Example Response:

Tide Times:
Time: 2024-01-20T00:30:00+00:00 (UTC)
Type: HIGH tide
Height: 1.52m

Time: 2024-01-20T06:45:00+00:00 (UTC)
Type: LOW tide
Height: 0.25m

Station Information:
Name: Sample Station
Distance: 20.5km from requested location

Use Cases

Example #1: Finding the Best Surf Time

You can use this tool to determine the optimal surfing time at your favorite beach & the closest station. Generally, the best surfing conditions are during incoming (rising) tides, about 2 hours before high tide.

Example prompt to Claude:

Screenshot 2025-01-07 at 12 55 47 PM

Note: Different beaches may have different optimal tide conditions based on their specific geography and break type. This tool also provides station distance information which should be considered alongside tide information. (ie. longer station distance means higher change of innacuracy - you can ask Claude for this as well when prompting).

Error Handling

The service includes robust error handling for:

  • API request failures
  • Invalid coordinates
  • Missing or invalid API keys
  • Network timeouts

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_surf_mcp-0.1.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_surf_mcp-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_surf_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_surf_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.9

File hashes

Hashes for iflow_mcp_surf_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e9067a836b06ef2c3465d3b7ed42eaf8bcda3fa6f166a7ad285f52626a1a12d1
MD5 f5b5cd66707366dcaa10c240049e57de
BLAKE2b-256 e58a368f10729824c3ccd130baa9377e915088a3446bba8a5de5481fe49d9a65

See more details on using hashes here.

File details

Details for the file iflow_mcp_surf_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iflow_mcp_surf_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54f50e2f1647f2bd5954479171c9d1c017e5b4b772bca26b462cf42a69eda13c
MD5 6fa06e2b1328dcea0945d0e1bd06bc80
BLAKE2b-256 39e0a4656291ae507bd9111dc6da007e0323888d636936ab12af841c651a67e8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page