Skip to content

Commit ff88685

Browse files
committed
docs: stop documenting the deprecated cli.mcp field
1 parent d31fa13 commit ff88685

7 files changed

Lines changed: 8 additions & 9 deletions

File tree

‎docs/content/3.frameworks/1.vite.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Devframe spawns a separate RPC + WS server and registers Vite middleware at `<ba
4242
| `host` | `def.cli?.host ?? 'localhost'` | Bind host for a pinned side-car. |
4343
| `flags` | none | To `def.setup(ctx, { flags })`. |
4444
| `auth` | gated (interactive OTP) | `false` to opt out, or a `DevframeAuthHandler` for a custom scheme. |
45-
| `mcp` | `def.cli?.mcp`, then `'auto'` | Expose the MCP route at `<base>__mcp`. `'auto'` mounts once agent tools exist; `true` forces the origin-only route on (trusts same-machine callers); `McpRouteOptions` can add an `authorization` identity check. |
45+
| `mcp` | `'auto'` | Expose the MCP route at `<base>__mcp`. `'auto'` mounts once agent tools exist; `true` forces the origin-only route on (trusts same-machine callers); `McpRouteOptions` can add an `authorization` identity check. |
4646

4747
## `devframeVite`: convenience wrapper
4848

‎docs/content/3.frameworks/3.next.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export const GET = handler.fetch
4848
| `port` | from `def.cli?.port` | Side-car port. |
4949
| `flags` | none | Passed to `def.setup(ctx, { flags })`. |
5050
| `auth` | `false` | `true` for the OTP gate, or a handler. |
51-
| `mcp` | `def.cli?.mcp`, then `'auto'` | Expose the MCP route. `'auto'` mounts once agent tools exist; `true` forces the origin-only route on (trusts same-machine callers); `McpRouteOptions` can add an `authorization` identity check. |
51+
| `mcp` | `'auto'` | Expose the MCP route. `'auto'` mounts once agent tools exist; `true` forces the origin-only route on (trusts same-machine callers); `McpRouteOptions` can add an `authorization` identity check. |
5252
| `key` | `@devframes/next:<id>:<base>` | `globalThis` memoization key. |
5353

5454
## Hosting a hub

‎docs/content/6.errors/DF0017.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The MCP server failed while initializing. Common reasons:
1616

1717
## Fix
1818

19-
- **Missing SDK**: `pnpm add @modelcontextprotocol/server` in the package that imports `devframe/adapters/mcp` or enables `cli.mcp`.
19+
- **Missing SDK**: `pnpm add @modelcontextprotocol/server` in the package that imports `devframe/adapters/mcp` or enables the `mcp` setting.
2020
- **Transport failure**: inspect the underlying error attached as `cause`.
2121

2222
## Source

‎docs/content/6.errors/DF0051.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The `devframe connect` gateway tool `devframe_connect_call-tool` targeted a live
2020

2121
## Fix
2222

23-
Restart the instance with the `--mcp` flag (or set `cli.mcp: true` on its definition) to expose its tools, then list instances again.
23+
Restart the instance with the `--mcp` flag (or pass `mcp: true` to `createCac` / its programmatic host) to expose its tools, then list instances again.
2424

2525
## Source
2626

‎docs/content/6.errors/DF0077.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export const getState = defineRpcFunction({
2828
## Fix
2929

3030
- Install the peer next to `devframe` so the `'auto'` default can serve the surface: `npm install @modelcontextprotocol/server`.
31-
- Or set `mcp: false` (on `cli.mcp`, or the `mcp` option of `initDevframe` / `initHub` / `createDevServer`) to keep the route off and silence the warning.
31+
- Or set `mcp: false` where you host the tool (`createCac`, `initDevframe`, `initHub`, or `createDevServer`) to keep the route off and silence the warning.
3232

3333
## Source
3434

‎docs/content/6.errors/DF8005.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ description: 'Devframe "{id}" requests an MCP route, but the hub''s aggregate MC
99
1010
## Cause
1111

12-
A hub exposes **one aggregate MCP endpoint** over every mounted devframe (tool ids are already namespaced per plugin), so a mounted devframe's own `mcp` setting is ignored: the hub's own `mcp` governs the route. This warning fires when a devframe is mounted with `cli.mcp` enabled while the hub set `mcp: false`, so that devframe's tools are not reachable over MCP.
12+
A hub exposes **one aggregate MCP endpoint** over every mounted devframe (tool ids are already namespaced per plugin), so a mounted devframe's own `mcp` setting is ignored: the hub's own `mcp` governs the route. This warning fires when a mounted devframe's definition enables MCP through the deprecated `cli.mcp` field while the hub set `mcp: false`, so that devframe's tools are not reachable over MCP.
1313

1414
## Example
1515

16-
The hub below turned MCP off, but a mounted devframe declares `cli.mcp: true`:
16+
The hub below turned MCP off, but a mounted devframe's definition requests MCP:
1717

1818
```ts
1919
initHub({
2020
base: DEVFRAMES_HUB_BASE,
2121
mcp: false,
22-
devframes: [myDevframe], // myDevframe sets `cli.mcp: true`, so DF8005
22+
devframes: [myDevframe], // myDevframe's definition requests MCP, so DF8005
2323
})
2424
```
2525

‎docs/content/8.references/4.node-api.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ The `cli` field's `DevframeCliOptions`: [CLI options](/guide/devframe-definition
4343
| `host` | `string` | Default bind host. |
4444
| `open` | `boolean \| string` | `true` = origin, string = a path, `false` = off (`--open`/`--no-open`). With `auth`, embeds the OTP. |
4545
| `auth` | `boolean` | Disable WS trust flow when localhost-only, single-user. Default `true`. |
46-
| `mcp` | `McpSetting` | Deprecated fallback for the route-based MCP setting; pass `mcp` to `createCac` (or the programmatic host) instead. `'auto'` (default) mounts once agent tools exist and the peer resolves. See [MCP](/adapters/mcp#route-based-server). |
4746
| `configure` | `(cli: CAC) => void` | Contribute flags/commands before `createCac`'s `configureCli`. |
4847

4948
## Storage scopes

0 commit comments

Comments
 (0)