Spaces:
Running
Running
docs: update README.md with comprehensive project description and usage guide
Browse files
README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
| 1 |
---
|
| 2 |
-
title: Official
|
| 3 |
emoji: 🏃
|
| 4 |
colorFrom: green
|
| 5 |
colorTo: blue
|
|
@@ -8,7 +8,23 @@ pinned: false
|
|
| 8 |
license: apache-2.0
|
| 9 |
---
|
| 10 |
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
## MCP Server (FastMCP)
|
| 14 |
|
|
@@ -25,7 +41,7 @@ This project includes a minimal [FastMCP 2.0](https://gofastmcp.com/) server in
|
|
| 25 |
python app.py
|
| 26 |
```
|
| 27 |
|
| 28 |
-
The server will be available on
|
| 29 |
|
| 30 |
### How to run with Docker
|
| 31 |
|
|
@@ -39,3 +55,18 @@ The server will be available on the default MCP port (see FastMCP documentation
|
|
| 39 |
```
|
| 40 |
|
| 41 |
The server will be available on port 7860 (SSE transport).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Official French Government URL List
|
| 3 |
emoji: 🏃
|
| 4 |
colorFrom: green
|
| 5 |
colorTo: blue
|
|
|
|
| 8 |
license: apache-2.0
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# Official French Government URL List
|
| 12 |
+
|
| 13 |
+
A Model Context Protocol (MCP) server that provides access to official French government domain lists and URL resources.
|
| 14 |
+
|
| 15 |
+
## Features
|
| 16 |
+
|
| 17 |
+
- **FastMCP 2.0 Server**: Modern MCP server implementation
|
| 18 |
+
- **Public Resources**: Access to official government domain lists
|
| 19 |
+
- **Docker Support**: Easy deployment with containerization
|
| 20 |
+
- **SSE Transport**: Real-time communication support
|
| 21 |
+
|
| 22 |
+
## Available Resources
|
| 23 |
+
|
| 24 |
+
The server exposes the following MCP resources:
|
| 25 |
+
|
| 26 |
+
- `resource://sitesgouv-txt` - Official government URL list from [auracom.fr](https://www.auracom.fr/gouv/sitesgouv.txt)
|
| 27 |
+
- `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)
|
| 28 |
|
| 29 |
## MCP Server (FastMCP)
|
| 30 |
|
|
|
|
| 41 |
python app.py
|
| 42 |
```
|
| 43 |
|
| 44 |
+
The server will be available on port 7860 with SSE transport.
|
| 45 |
|
| 46 |
### How to run with Docker
|
| 47 |
|
|
|
|
| 55 |
```
|
| 56 |
|
| 57 |
The server will be available on port 7860 (SSE transport).
|
| 58 |
+
|
| 59 |
+
## Usage
|
| 60 |
+
|
| 61 |
+
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.
|
| 62 |
+
|
| 63 |
+
## Development
|
| 64 |
+
|
| 65 |
+
This project uses:
|
| 66 |
+
- [FastMCP 2.0](https://gofastmcp.com/) for MCP server implementation
|
| 67 |
+
- Python 3.11+ for runtime
|
| 68 |
+
- Docker for containerization
|
| 69 |
+
|
| 70 |
+
## License
|
| 71 |
+
|
| 72 |
+
Apache 2.0 License
|