@omnizoek/mcp-server 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -135,6 +135,74 @@ Once configured, you can ask your AI agent:
135
135
 
136
136
  ---
137
137
 
138
+ ## Remote deployment (HTTP / Glama.ai Connector)
139
+
140
+ The package ships a second entry point — `dist/http.js` — that exposes the same
141
+ 16 tools via MCP Streamable HTTP transport. Use this to run OmniZoek MCP as a
142
+ remote server.
143
+
144
+ ### Run locally
145
+
146
+ ```bash
147
+ PORT=3000 OMNIZOEK_API_KEY=omni_live_... npx omnizoek-mcp-http
148
+ # MCP endpoint: POST http://localhost:3000/mcp
149
+ # Health check: GET http://localhost:3000/health
150
+ ```
151
+
152
+ ### Docker (HTTP mode)
153
+
154
+ ```bash
155
+ docker run -p 3000:3000 \
156
+ -e OMNIZOEK_API_KEY=omni_live_... \
157
+ -e HTTP_MODE=1 \
158
+ omnizoek/mcp-server
159
+ ```
160
+
161
+ ### Cloud Run (Google Cloud)
162
+
163
+ ```bash
164
+ gcloud run deploy omnizoek-mcp \
165
+ --image omnizoek/mcp-server \
166
+ --set-env-vars HTTP_MODE=1 \
167
+ --port 3000 \
168
+ --allow-unauthenticated
169
+
170
+ # Map custom domain (CNAME mcp → ghs.googlehosted.com already set in DNS)
171
+ gcloud run domain-mappings create \
172
+ --service omnizoek-mcp \
173
+ --domain mcp.omnizoek.nl \
174
+ --region europe-west4
175
+ ```
176
+
177
+ The MCP endpoint will be available at `https://mcp.omnizoek.nl/mcp`.
178
+
179
+ ### Authentication
180
+
181
+ Pass your OmniZoek API key on each request via either header:
182
+
183
+ ```
184
+ Authorization: Bearer omni_live_YOUR_KEY
185
+ X-Api-Key: omni_live_YOUR_KEY
186
+ ```
187
+
188
+ The server requires a key on every request — there is no server-side fallback key.
189
+ This means the deployed endpoint cannot be abused to bill a single account;
190
+ each caller must supply their own key.
191
+
192
+ > For private/single-tenant deployments you can set `OMNIZOEK_ALLOW_ENV_KEY=1`
193
+ > alongside `OMNIZOEK_API_KEY` to use the env var as a fallback.
194
+
195
+ ### Glama.ai Connector submission
196
+
197
+ | Field | Value |
198
+ |---|---|
199
+ | Name | OmniZoek |
200
+ | Description | 16 Dutch government data APIs — address enrichment, IBAN→BIC, VAT verify, geocode, vehicle history, energy labels, exchange rates and more. |
201
+ | Server URL | `https://mcp.omnizoek.nl/mcp` |
202
+ | Private Notes | `Authorization: Bearer omni_test_YOUR_KEY` (use a **test key** — never billed) |
203
+
204
+ ---
205
+
138
206
  ## Development
139
207
 
140
208
  ```bash