# Open Data Model Context Protocol

![vc3598_Hyper-realistic_Swiss_landscape_pristine_SBB_red_train_p_40803c2e-43f5-410e-89aa-f6bdcb4cd089](https://github.com/user-attachments/assets/80c823dd-0b26-4d06-98f9-5c6d7c9103de)


[![PyPI version](https://badge.fury.io/py/odmcp.svg)](https://badge.fury.io/py/odmcp&cache-control=no-cache)
[![CI](https://github.com/OpenDataMCP/OpenDataMCP/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenDataMCP/OpenDataMCP/actions/workflows/ci.yml&cache-control=no-cache)
[![GitHub stars](https://img.shields.io/github/stars/OpenDataMCP/OpenDataMCP.svg)](https://github.com/OpenDataMCP/OpenDataMCP/stargazers&cache-control=no-cache)
[![License](https://img.shields.io/github/license/OpenDataMCP/OpenDataMCP.svg)](https://github.com/OpenDataMCP/OpenDataMCP/blob/main/LICENSE)

<!--
[![Downloads](https://pepy.tech/badge/odmcp)](https://pepy.tech/project/odmcp)
-->

## Connect any Open Data to LLMs in minutes!

https://github.com/user-attachments/assets/8b4eeab3-d111-4e0d-9e7b-5108cd12c58f

We enable 2 things: 

* **Open Data Access**: Access to many public datasets right from your LLM application (starting with Claude, more to come).
* **Publishing**: Get community help and a distribution network to distribute your Open Data. Get everyone to use it!

How do we do that?

* **Access**: Setup our MCP servers in your LLM application in 2 clicks via our CLI tool (starting with Claude, see Roadmap for next steps).
* **Publish**: Use provided templates and guidelines to quickly contribute and publish on Open Data MCP. Make your data easily discoverable!

## Usage

### <u>Access</u>: Access Open Data using Open Data MCP CLI Tool

#### Prerequisites

If you want to use Open Data MCP with Claude Desktop app client you need to install the [Claude Desktop app](https://claude.ai/download).

You will also need `uv` to easily run our CLI and MCP servers.

##### macOS

```bash
# you need to install uv through homebrew as using the install shell script 
# will install it locally to your user which make it unavailable in the Claude Desktop app context.
brew install uv
```

##### Windows

```bash
# (UNTESTED)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

#### Open Data MCP - CLI Tool

##### Overview

```bash
# show available commands
uvx odmcp 

# show available providers
uvx odmcp list

# show info about a provider
uvx odmcp info $PROVIDER_NAME

# setup a provider's MCP server on your Claude Desktop app
uvx odmcp setup $PROVIDER_NAME

# remove a provider's MCP server from your Claude Desktop app
uvx odmcp remove $PROVIDER_NAME
```

##### Example

Quickstart for the Switzerland SBB (train company) provider:

```bash
# make sure claude is installed
uvx odmcp setup ch_sbb
```

Restart Claude and you should see a new hammer icon at the bottom right of the chat.

You can now ask questions to Claude about SBB train network disruption and it will answer based on data collected on `data.sbb.ch`.

### <u>Publish</u>: Contribute by building and publishing public datasets

#### Prerequisites

1. **Install UV Package Manager**
   ```bash
   # macOS
   brew install uv

   # Windows (PowerShell)
   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

   # Linux/WSL
   curl -LsSf https://astral.sh/uv/install.sh | sh
   ```

2. **Clone & Setup Repository**
   ```bash
   # Clone the repository
   git clone https://github.com/OpenDataMCP/OpenDataMCP.git
   cd OpenDataMCP

   # Create and activate virtual environment
   uv venv
   source .venv/bin/activate  # Unix/macOS
   # or
   .venv\Scripts\activate     # Windows

   # Install dependencies
   uv sync
   ```

3. **Install Pre-commit Hooks**
   ```bash
   # Install pre-commit hooks for code quality
   pre-commit install
   ```

#### Publishing Instructions

1. **Create a New Provider Module**
   * Each data source needs its own python module.
   * Create a new Python module in `src/odmcp/providers/`.
   * Use a descriptive name following the pattern: `{country_code}_{organization}.py` (e.g., `ch_sbb.py`).
   * Start with our [template file](https://github.com/OpenDataMCP/OpenDataMCP/blob/main/src/odmcp/providers/__template__.py) as your base.

2. **Implement Required Components**
   * Define your Tools & Resources following the template structure
   * Each Tool or Resource should have:
     - Clear description of its purpose
     - Well-defined input/output schemas using Pydantic models
     - Proper error handling
     - Documentation strings

3. **Tool vs Resource**
   * Choose **Tool** implementation if your data needs:
     - Active querying or computation
     - Parameter-based filtering
     - Complex transformations
   * Choose **Resource** implementation if your data is:
     - Static or rarely changing
     - Small enough to be loaded into memory
     - Simple file-based content
     - Reference documentation or lookup tables
   * Reference the [MCP documentation](https://github.com/modelcontextprotocol/python-sdk?tab=readme-ov-file#primitives) for guidance

4. **Testing**
   * Add tests in the `tests/` directory
   * Follow existing test patterns (see other provider tests)
   * Required test coverage:
     - Basic functionality
     - Edge cases
     - Error handling

5. **Validation**
   * Test your MCP server using our experimental client: `uv run src/odmcp/providers/client.py`
   * Verify all endpoints respond correctly
   * Ensure error messages are helpful
   * Check performance with typical query loads

For other examples, check our existing providers in the `src/odmcp/providers/` directory.

## Contributing

We have an ambitious roadmap and we want this project to scale with the community. The ultimate goal is to make the millions of datasets publicly available to all LLM applications. 

For that we need your help!

### Discord

We want to build a helping community around the challenge of bringing open data to LLM's. Join us on discord to start chatting: https://discord.gg/QPFFZWKW

### Our Core Guidelines

Because of our target scale we want to keep things simple and pragmatic at first. Tackle issues with the community as they come along.

1. **Simplicity and Maintainability**
   * Minimize abstractions to keep codebase simple and scalable
   * Focus on clear, straightforward implementations
   * Avoid unnecessary complexity

2. **Standardization / Templates**
   * Follow provided templates and guidelines consistently
   * Maintain uniform structure across providers
   * Use common patterns for similar functionality

3. **Dependencies**
   * Keep external dependencies to a minimum
   * Prioritize single repository/package setup
   * Carefully evaluate necessity of new dependencies

4. **Code Quality**
   * Format code using ruff
   * Maintain comprehensive test coverage with pytest
   * Follow consistent code style

5. **Type Safety**
   * Use Python type hints throughout
   * Leverage Pydantic models for API request/response validation
   * Ensure type safety in data handling

### Tactical Topics (our current priorities)
* [x] Initialize repository with guidelines, testing framework, and contribution workflow
* [x] Implement CI/CD pipeline with automated PyPI releases
* [x] Develop provider template and first reference implementation
* [ ] **Integrate additional open datasets (actively seeking contributors)**
* [ ] Establish clear guidelines for choosing between Resources and Tools
* [ ] Develop scalable repository architecture for long-term growth
* [ ] Expand MCP SDK parameter support (authentication, rate limiting, etc.)
* [ ] Implement additional MCP protocol features (prompts, resource templates)
* [ ] Add support for alternative transport protocols beyond stdio (SSE)
* [ ] Deploy hosted MCP servers for improved accessibility

## Roadmap
Let’s build the open source infrastructure that will allow all LLMs to access all Open Data together!

### Access:
* Make Open Data available to all LLM applications (beyond Claude)
* Make Open Data data sources searchable in a scalable way
* Make Open Data available through MCP remotely (SSE) with publicly sponsored infrastructure

### Publish:
* Build the many Open Data MCP servers to make all the Open Data truly accessible (we need you!).
* On our side we are starting to build MCP servers for Switzerland ~12k open dataset! 
* Make it even easier to build Open Data MCP servers

We are very early, and lack of dataset available is currently the bottleneck. Help yourself! Create your Open Data MCP server and get users to use it as well from their LLMs applications. Let’s connect LLMs to the millions of open datasets from governments, public entities, companies and NGOs!

As Anthropic's MCP evolves we will adapt and upgrade Open Data MCP.

## Limitations

* All data served by Open Data MCP servers should be Open. 
* Please oblige to the data licenses of the data providers.
* Our License must be quoted in commercial applications.

## References

* Kudos to Anthropic's open source MCP release enabling initiative like this one

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
