kokluch's picture
docs: update README.md with comprehensive project description and usage guide
c0062a5
---
title: Official French Government URL List
emoji: πŸƒ
colorFrom: green
colorTo: blue
sdk: docker
pinned: false
license: apache-2.0
---
# Official French Government URL List
A Model Context Protocol (MCP) server that provides access to official French government domain lists and URL resources.
## Features
- **FastMCP 2.0 Server**: Modern MCP server implementation
- **Public Resources**: Access to official government domain lists
- **Docker Support**: Easy deployment with containerization
- **SSE Transport**: Real-time communication support
## Available Resources
The server exposes the following MCP resources:
- `resource://sitesgouv-txt` - Official government URL list from [auracom.fr](https://www.auracom.fr/gouv/sitesgouv.txt)
- `resource://public-org-domains-csv` - Public organization domains CSV from [adullact.net](https://gitlab.adullact.net/dinum/noms-de-domaine-organismes-secteur-public/-/blob/master/domains.csv)
## MCP Server (FastMCP)
This project includes a minimal [FastMCP 2.0](https://gofastmcp.com/) server in `app.py`.
### How to run
1. Install dependencies:
```bash
pip install -r requirements.txt
```
2. Start the server:
```bash
python app.py
```
The server will be available on port 7860 with SSE transport.
### How to run with Docker
1. Build the Docker image:
```bash
docker build -t official-gouv-url-list .
```
2. Run the container:
```bash
docker run -p 7860:7860 official-gouv-url-list
```
The server will be available on port 7860 (SSE transport).
## Usage
Once the server is running, MCP clients can access the resources using standard MCP protocol calls. The server supports Server-Sent Events (SSE) for real-time communication.
## Development
This project uses:
- [FastMCP 2.0](https://gofastmcp.com/) for MCP server implementation
- Python 3.11+ for runtime
- Docker for containerization
## License
Apache 2.0 License