Skip to content

Commit b538547

Browse files
committed
chore: update README and schema for clarity on portal URL usage
1 parent 3cd6964 commit b538547

File tree

3 files changed

+22
-9
lines changed

3 files changed

+22
-9
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
# mcp
1+
# <img alt="Data FAIR logo" src="https://cdn.jsdelivr.net/gh/data-fair/data-fair@master/ui/public/assets/logo.svg" width="25"> @data-fair/mcp ![GitHub License](https://img.shields.io/github/license/data-fair/mcp) ![GitHub package.json version](https://img.shields.io/github/package-json/v/data-fair/mcp)
22

3-
Model Context Protocol (MCP) servers to allow AI agents to interact with the Data Fair ecosystem.
3+
A Model Context Protocol (MCP) server to interact with the Data Fair ecosystem.
44

5-
## Environment Variables
5+
## ⚙️ Environment Variables
66

7-
- `PORTAL_URL`: URL of the data-fair portal (e.g., `https://opendata.koumoul.com` or `https://data.ademe.fr`).
8-
- `OBSERVER_ACTIVE`: enable observer (true/false)
9-
- `PORT`: port for the server to listen on
10-
- `TRANSPORT`: transport mode (`stdio` or `http`)
7+
| Variable | Description | Default | Mode |
8+
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------------|
9+
| `PORTAL_URL` | Base URL of the Data Fair portal. If not set and `TRANSPORT=http`, the portal URL is inferred from the request origin. When `TRANSPORT=stdio`, you must set this value. || http/stdio |
10+
| `OBSERVER_ACTIVE` | Enable Prometheus metrics. | `true` | http only |
11+
| `OBSERVER_PORT` | Port for the Prometheus metrics observer. | `9090` | http only |
12+
| `PORT` | Port for the HTTP server to listen on. | `8080` | http only |
13+
| `TRANSPORT` | Transport mode : `stdio` or `http` | `stdio` | http/stdio |
14+
15+
Notes:
16+
17+
- In HTTP mode, `PORTAL_URL` is optional (derived from request origin). In stdio mode, it is required.
18+
- Prometheus metrics (observer) run only in HTTP mode.
19+
20+
## 🔨 Development
21+
22+
Take a look at the [contribution guidelines](./CONTRIBUTING.md).

config/type/schema.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
"properties": {
2121
"portalUrl": {
2222
"type": "string",
23-
"description": "The URL of the portal. By default, in http mode the host of the request is used."
23+
"description": "Base URL of the Data Fair portal. If not set and transport=\"http\", the portal URL is inferred from the request origin. When transport=\"stdio\", you must set this value.",
24+
"example": "https://opendata.koumoul.com"
2425
},
2526
"observer": {
2627
"type": "object",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@data-fair/mcp",
33
"version": "0.0.0",
4-
"description": "Model Context Protocol servers for the Data Fair ecosystem",
4+
"description": "A Model Context Protocol server for the Data Fair ecosystem",
55
"type": "module",
66
"main": "index.ts",
77
"scripts": {

0 commit comments

Comments
 (0)