Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@ Complete guide to using the PatternFly MCP Server for development including CLI
| `--verbose` | Shortcut for `--log-level debug` | `false` |

#### Notes
- **HTTP transport mode** - By default, the server uses `stdio`. Use the `--http` flag to enable HTTP transport.
- **HTTP transport mode** - By default, the server uses `stdio`. Use the `--http` flag to enable HTTP transport. Sub-flags like `--port`, `--host`, etc. only apply when `--http` is set.
- **Logging** - The server uses a `diagnostics_channel`-based logger that keeps stdout pure by default.
- **Programmatic API** - The server can also be used programmatically with options. See [Programmatic usage](#programmatic-usage) for more details.
- **Tool plugins** - The server can load external tool plugins at startup. See [MCP tool plugins](#mcp-tool-plugins) for more details.
- **Test Mode** - When `--mode test` is used, the server redirects resource requests to the URL provided by `--mode-test-url`, enabling E2E testing without local filesystem access.
- **Experimental options** - When an option is registered as experimental, use `--experimental-<lorem-ipsum>` on the CLI; for programmatic options use `experimental<LoremIpsum>`.

### Basic use scenarios

Expand Down Expand Up @@ -120,6 +121,9 @@ The `start()` function accepts an optional `PfMcpOptions` object for programmati
| `modeOptions.test.baseUrl` | `string` | Base URL for fixture/mock servers in `test` mode. | `undefined` |
| `docsPaths` | `string[]` | Whitelist of local documentation directories resolved by `documentation:` slug. When empty (default), the slug is dormant. | `[]` |

#### Notes
- **Experimental options** - When an option is registered as experimental use `experimental<LoremIpsum>` for programmatic options; for CLI options use `--experimental-<lorem-ipsum>`.

#### Example usage

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ exports[`options defaults should return specific properties: defaults 1`] = `
"contextUrl": "file:///",
"docsPathSlug": "documentation:",
"docsPaths": [],
"experimental": [],
"http": {
"allowedHosts": [],
"allowedOrigins": [],
Expand Down
335 changes: 0 additions & 335 deletions src/__tests__/__snapshots__/options.test.ts.snap

This file was deleted.

Loading
Loading