Skip to content

Commit c682bb4

Browse files
committed
Update docs
1 parent 69f1adf commit c682bb4

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/MCP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ REST routes and MCP tools are gated by model configuration.
114114
### Master Options (Model Level)
115115

116116
At the model level, two master options in the `options` array control access:
117-
- **`show_in_rest`**: Controls whether model-scoped REST routes (and consequently MCP tools) are registered. If explicitly set to `false`, all model-scoped REST and MCP capabilities for the model are disabled. Defaults to `true` (if omitted or not `false`).
117+
- **`show_in_rest`**: Controls whether model-scoped REST routes are registered. If explicitly set to `false`, all model-scoped REST capabilities for the model are disabled. It does not control whether the model's MCP tools are generated/shown (which is managed by `mcp_tools` and `show_in_mcp`), although calling those MCP tools will fail if the underlying REST route is disabled. Defaults to `true` (if omitted or not `false`).
118118
- **`mcp_tools`**: Must be set and truthy (e.g., `true`) in model options to enable any MCP tools for that model.
119119

120120
The framework-scoped health capability (`health` ability / REST route) is independent of per-model opt-in and is always available. The `models` capability is always enabled for a model as long as its `show_in_rest` is not `false` (or always, for MCP, if `mcp_tools` is enabled).
@@ -181,7 +181,7 @@ return [
181181
];
182182
```
183183

184-
If `show_in_rest` is explicitly `false`, Saltus does not expose model-scoped REST or MCP routes for that model. The health ability is framework-scoped and remains independent of per-model opt-in.
184+
If `show_in_rest` is explicitly `false`, Saltus does not register the model-scoped REST routes. The `mcp_tools` option controls whether MCP tools are exposed. The health ability is framework-scoped and remains independent of per-model opt-in.
185185

186186
## Available Abilities
187187

@@ -318,15 +318,15 @@ Audit retention cleanup runs through the daily `saltus_framework_mcp_audit_clean
318318
| WordPress with Abilities API | Saltus registers `saltus/*` abilities |
319319
| WordPress without Abilities API | Saltus skips native ability registration |
320320
| `mcp_tools` not set or `false` | No MCP tools are generated for that model |
321-
| `show_in_rest` set to `false` | Model-scoped Saltus REST and MCP routes are unavailable for that model |
321+
| `show_in_rest` set to `false` | Model-scoped Saltus REST routes are disabled (calling any corresponding MCP tools will fail) |
322322
| No WordPress-native MCP client | Saltus abilities are registered, but no client consumes them |
323323

324324
## Troubleshooting
325325

326326
| Symptom | Check |
327327
|---------|-------|
328328
| No `saltus/*` abilities appear | Confirm the WordPress build provides the Abilities API and the plugin is active |
329-
| A model is missing from MCP results | Confirm the model has `show_in_rest` and `mcp_tools` enabled, and required feature-level `show_in_mcp` flags |
329+
| A model is missing from MCP results | Confirm the model has `mcp_tools` enabled, and required feature-level `show_in_mcp` flags |
330330
| A write operation fails | Confirm the current WordPress user has the needed post, taxonomy, or settings capability |
331331
| Calls are throttled | Check `saltus/framework/mcp/rate_limit/*` filters |
332332
| Results look stale | Clear transients or disable MCP cache while testing |

0 commit comments

Comments
 (0)