@arabold/docs-mcp-server 1.25.0 → 1.25.1
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 +34 -0
- package/dist/index.js +770 -694
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -322,6 +322,40 @@ This architecture allows independent scaling of processing (workers) and user in
|
|
|
322
322
|
|
|
323
323
|
The Docs MCP Server can run without any configuration and will use full-text search only. To enable vector search for improved results, configure an embedding provider via environment variables.
|
|
324
324
|
|
|
325
|
+
### Command Line Argument Overrides
|
|
326
|
+
|
|
327
|
+
Many CLI arguments can be overridden using environment variables. This is useful for Docker deployments, CI/CD pipelines, or setting default values.
|
|
328
|
+
|
|
329
|
+
| Environment Variable | CLI Argument | Description | Used by Commands |
|
|
330
|
+
| -------------------------- | ---------------------- | ----------------------------------------------- | ------------------------- |
|
|
331
|
+
| `DOCS_MCP_STORE_PATH` | `--store-path` | Custom path for data storage directory | all |
|
|
332
|
+
| `DOCS_MCP_TELEMETRY` | `--no-telemetry` | Disable telemetry (`false` to disable) | all |
|
|
333
|
+
| `DOCS_MCP_PROTOCOL` | `--protocol` | MCP server protocol (auto, stdio, http) | default, mcp |
|
|
334
|
+
| `DOCS_MCP_PORT` | `--port` | Server port | default, mcp, web, worker |
|
|
335
|
+
| `DOCS_MCP_WEB_PORT` | `--port` (web command) | Web interface port (web command only) | web |
|
|
336
|
+
| `PORT` | `--port` | Server port (fallback if DOCS_MCP_PORT not set) | default, mcp, web, worker |
|
|
337
|
+
| `DOCS_MCP_HOST` | `--host` | Server host/bind address | default, mcp, web, worker |
|
|
338
|
+
| `HOST` | `--host` | Server host (fallback if DOCS_MCP_HOST not set) | default, mcp, web, worker |
|
|
339
|
+
| `DOCS_MCP_EMBEDDING_MODEL` | `--embedding-model` | Embedding model configuration | default, mcp, web, worker |
|
|
340
|
+
| `DOCS_MCP_AUTH_ENABLED` | `--auth-enabled` | Enable OAuth2/OIDC authentication | default, mcp |
|
|
341
|
+
| `DOCS_MCP_AUTH_ISSUER_URL` | `--auth-issuer-url` | OAuth2 provider issuer/discovery URL | default, mcp |
|
|
342
|
+
| `DOCS_MCP_AUTH_AUDIENCE` | `--auth-audience` | JWT audience claim (resource identifier) | default, mcp |
|
|
343
|
+
|
|
344
|
+
**Usage Examples:**
|
|
345
|
+
|
|
346
|
+
```bash
|
|
347
|
+
# Set via environment variables
|
|
348
|
+
export DOCS_MCP_PORT=8080
|
|
349
|
+
export DOCS_MCP_HOST=0.0.0.0
|
|
350
|
+
export DOCS_MCP_EMBEDDING_MODEL=text-embedding-3-small
|
|
351
|
+
npx @arabold/docs-mcp-server@latest
|
|
352
|
+
|
|
353
|
+
# Override with CLI arguments (takes precedence)
|
|
354
|
+
DOCS_MCP_PORT=8080 npx @arabold/docs-mcp-server@latest --port 9090
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### Embedding Provider Configuration
|
|
358
|
+
|
|
325
359
|
The Docs MCP Server is configured via environment variables. Set these in your shell, Docker, or MCP client config.
|
|
326
360
|
|
|
327
361
|
| Variable | Description |
|