Skip to main content

An OpenStreetMap MCP server

Project description

OpenStreetMap (OSM) MCP Server

An OpenStreetMap MCP server implementation that enhances LLM capabilities with location-based services and geospatial data.

Demo

Meeting Point Optimization

Meeting Point Use Case

Neighborhood Analysis

Neighborhood Analysis Use Case

Parking Search

Parking Search Use Case

Installation

In MCP Hosts like Claude Desktop, Cursor, Windsurf, etc.

  • osm-mcp-server: The main server, available for public use.

    "mcpServers": {
      "osm-mcp-server": {
        "command": "uvx",
        "args": [
          "osm-mcp-server"
        ]
      }
    }
    

Features

This server provides LLMs with tools to interact with OpenStreetMap data, enabling location-based applications to:

  • Geocode addresses and place names to coordinates
  • Reverse geocode coordinates to addresses
  • Find nearby points of interest
  • Get route directions between locations
  • Search for places by category within a bounding box
  • Suggest optimal meeting points for multiple people
  • Explore areas and get comprehensive location information
  • Find schools and educational institutions near a location
  • Analyze commute options between home and work
  • Locate EV charging stations with connector and power filtering
  • Perform neighborhood livability analysis for real estate
  • Find parking facilities with availability and fee information

Components

Resources

The server implements location-based resources:

  • location://place/{query}: Get information about places by name or address
  • location://map/{style}/{z}/{x}/{y}: Get styled map tiles at specified coordinates

Tools

The server implements several geospatial tools:

  • geocode_address: Convert text to geographic coordinates
  • reverse_geocode: Convert coordinates to human-readable addresses
  • find_nearby_places: Discover points of interest near a location
  • get_route_directions: Get turn-by-turn directions between locations
  • search_category: Find places of specific categories in an area
  • suggest_meeting_point: Find optimal meeting spots for multiple people
  • explore_area: Get comprehensive data about a neighborhood
  • find_schools_nearby: Locate educational institutions near a specific location
  • analyze_commute: Compare transportation options between home and work
  • find_ev_charging_stations: Locate EV charging infrastructure with filtering
  • analyze_neighborhood: Evaluate neighborhood livability for real estate
  • find_parking_facilities: Locate parking options near a destination

Local Testing

Running the Server

To run the server locally:

  1. Install the package in development mode:
pip install -e .
  1. Start the server:
osm-mcp-server
  1. The server will start and listen for MCP requests on the standard input/output.

Testing with Example Clients

The repository includes two example clients in the examples/ directory:

Basic Client Example

client.py demonstrates basic usage of the OSM MCP server:

python examples/client.py

This will:

  • Connect to the locally running server
  • Get information about San Francisco
  • Search for restaurants in the area
  • Retrieve comprehensive map data with progress tracking

LLM Integration Example

llm_client.py provides a helper class designed for LLM integration:

python examples/llm_client.py

This example shows how an LLM can use the Location Assistant to:

  • Get location information from text queries
  • Find nearby points of interest
  • Get directions between locations
  • Find optimal meeting points
  • Explore neighborhoods

Writing Your Own Client

To create your own client:

  1. Import the MCP client:
from mcp.client import Client
  1. Initialize the client with your server URL:
client = Client("http://localhost:8000")
  1. Invoke tools or access resources:
# Example: Geocode an address
results = await client.invoke_tool("geocode_address", {"address": "New York City"})

Claude Desktop config for local server

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

Development/Unpublished Servers Configuration
"mcpServers": {
  "osm-mcp-server": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/osm-mcp-server",
      "run",
      "osm-mcp-server"
    ]
  }
}

Development

Building and Publishing

To prepare the package for distribution:

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

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags.

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 via npm with this command:

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

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

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

osm_mcp_server-0.1.1.tar.gz (60.1 MB view details)

Uploaded Source

Built Distribution

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

osm_mcp_server-0.1.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file osm_mcp_server-0.1.1.tar.gz.

File metadata

  • Download URL: osm_mcp_server-0.1.1.tar.gz
  • Upload date:
  • Size: 60.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for osm_mcp_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 aec48dfed7a972a19f7049b43e45914c00035f0af28867591a9af4cc14547240
MD5 8066e252e46fbeb5c8b6224fc0cedc16
BLAKE2b-256 f7ddf89ab70f6afa474717b3aa9b4727b38aac41c8b124efa981028f2e1068e0

See more details on using hashes here.

File details

Details for the file osm_mcp_server-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: osm_mcp_server-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for osm_mcp_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef91ef228b1719fc427f33fcf27a00912a4eb95d1c66acb80bde11eb5dbdb1e4
MD5 dd2c7506f84b84e35395a2ffb4a895fa
BLAKE2b-256 eab1f0442a3e1bb3e884e9114b88e9d4ef46a967926b6fbbc2b87bea38e6e04b

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