Skip to content

Commit 0453055

Browse files
Add managed Codex MCP profiles and health checks
1 parent a9ac9cf commit 0453055

34 files changed

Lines changed: 1938 additions & 40 deletions

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ pnpm install
4949
pnpm dev
5050
```
5151

52-
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page directly. That page now covers service state, target selection, in-app memory search, and safe wrapper actions.
52+
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page directly. That page now covers service state, target selection, in-app memory search, target-scoped graph builds, and safe wrapper actions.
5353
The dashboard also exposes installable abilities and core services through the Workspace Capabilities panel, and supports a persisted `split` versus `discovery-first` repo layout.
5454

5555
If you want the fuller workspace path after that:
@@ -61,6 +61,7 @@ If you want the fuller workspace path after that:
6161
## How To Contribute
6262

6363
- Start with [.github/CONTRIBUTING.md](.github/CONTRIBUTING.md).
64+
- Use [docs/14-git-and-github-workflow.md](docs/14-git-and-github-workflow.md) for the default issue, discussion, branch, and PR path when a repo does not already document its own collaboration flow.
6465
- Browse current [`help wanted`](https://github.com/RichardGeorgeDavis/Codex-Workspace/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22) and [`good first issue`](https://github.com/RichardGeorgeDavis/Codex-Workspace/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) tickets.
6566
- If the queue is thin, use [docs/13-contributor-roadmap.md](docs/13-contributor-roadmap.md) for the current contribution map and ready-to-open starter issue briefs.
6667
- Use [GitHub Discussions Q&A](https://github.com/RichardGeorgeDavis/Codex-Workspace/discussions/categories/q-a) for setup or usage questions.
@@ -150,8 +151,12 @@ Start here:
150151
- [docs/README.md](docs/README.md)
151152
- [docs/08-first-run-and-updates.md](docs/08-first-run-and-updates.md)
152153
- [docs/09-new-repo-baseline.md](docs/09-new-repo-baseline.md)
153-
- [docs/13-contributor-roadmap.md](docs/13-contributor-roadmap.md)
154154
- [docs/12-maintainer-runbook.md](docs/12-maintainer-runbook.md)
155+
- [docs/13-contributor-roadmap.md](docs/13-contributor-roadmap.md)
156+
- [docs/14-git-and-github-workflow.md](docs/14-git-and-github-workflow.md)
157+
- [docs/15-mcp-profiles-and-trust-levels.md](docs/15-mcp-profiles-and-trust-levels.md)
158+
- [docs/16-mcp-profiles.md](docs/16-mcp-profiles.md)
159+
- [docs/17-mcp-install-and-health-check.md](docs/17-mcp-install-and-health-check.md)
155160
- [repos/workspace-hub/README.md](repos/workspace-hub/README.md)
156161

157162
Deeper docs:
@@ -166,6 +171,8 @@ Deeper docs:
166171
- [docs/07-context-cache-and-retrieval.md](docs/07-context-cache-and-retrieval.md)
167172
- [docs/10-release-readiness.md](docs/10-release-readiness.md)
168173
- [docs/11-core-memory-and-reference-promotion.md](docs/11-core-memory-and-reference-promotion.md)
174+
- [docs/18-mcp-server-catalog.md](docs/18-mcp-server-catalog.md)
175+
- [docs/19-mcp-authoring-rules.md](docs/19-mcp-authoring-rules.md)
169176

170177
Supporting references:
171178
- [docs/HANDOVER.md](docs/HANDOVER.md)
@@ -191,6 +198,7 @@ The practical model is:
191198
- generated context summaries under `cache/context/`
192199
- optional local workflow-state folders such as `.cognetivy/` kept separate from canonical tracked docs
193200
- local-only memory and MCP config kept separate from tracked repo content
201+
- a small official MCP v1 profile set for Codex, installed through workspace-owned scripts instead of ad hoc one-off setup
194202

195203
This keeps context easier to inspect, reason about, and adapt across tools while keeping each repo independently runnable.
196204

@@ -222,6 +230,8 @@ When a capability becomes part of how the whole workspace operates, prefer a cor
222230

223231
See:
224232
- [docs/06-cross-agent-skills-and-mcp.md](docs/06-cross-agent-skills-and-mcp.md)
233+
- [docs/15-mcp-profiles-and-trust-levels.md](docs/15-mcp-profiles-and-trust-levels.md)
234+
- [docs/17-mcp-install-and-health-check.md](docs/17-mcp-install-and-health-check.md)
225235
- [docs/07-context-cache-and-retrieval.md](docs/07-context-cache-and-retrieval.md)
226236
- [docs/11-core-memory-and-reference-promotion.md](docs/11-core-memory-and-reference-promotion.md)
227237
- [docs/12-maintainer-runbook.md](docs/12-maintainer-runbook.md)

docs/06-cross-agent-skills-and-mcp.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,22 @@ Additional hygiene for future workspace MCP tools:
295295

296296
Starter templates for this live in `tools/templates/mcp/`.
297297

298+
The current official MCP v1 policy and profile pack now lives in:
299+
300+
- `docs/15-mcp-profiles-and-trust-levels.md`
301+
- `docs/16-mcp-profiles.md`
302+
- `docs/17-mcp-install-and-health-check.md`
303+
- `docs/18-mcp-server-catalog.md`
304+
- `docs/19-mcp-authoring-rules.md`
305+
306+
The official v1 server set is intentionally small:
307+
308+
- `openaiDeveloperDocs`
309+
- `context7`
310+
- `playwright`
311+
- `chrome-devtools`
312+
- `github`
313+
298314
## Workspace Hub scope
299315

300316
Workspace Hub v1 should not require skills or MCP to function.

docs/08-first-run-and-updates.md

Lines changed: 89 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,28 @@ So if we want a predictable onboarding path, we need to provide it in tracked do
2020

2121
MemPalace is now integrated as the first core workspace memory service. The current bootstrap and doctor scripts can prepare and verify that service for the active workspace user.
2222

23-
## First-run questions
23+
## Fastest way to try it
24+
25+
If you want the most concrete path first, start with Workspace Hub rather than reading the whole docs tree up front.
26+
27+
Run:
28+
29+
```bash
30+
cd repos/workspace-hub
31+
pnpm install
32+
pnpm dev
33+
```
34+
35+
Then, once the app is open:
36+
37+
1. open `Workspace memory` from the header
38+
2. confirm service state and target context
39+
3. run a retrieval search from the in-app search form
40+
4. build a target-scoped graph for `Workspace docs` or a selected repo if you want the graph view
41+
42+
If that trial path is enough, stop there and keep the rest of this doc as optional setup and maintenance guidance.
43+
44+
## Optional first-run questions
2445

2546
Answer these in order:
2647

@@ -85,7 +106,7 @@ pnpm install
85106
pnpm dev
86107
```
87108

88-
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page. That page is the workspace-level view for memory state, target selection, and safe wrapper commands.
109+
Once the Hub is open, use the `Workspace memory` switch in the header to open the dedicated MemPalace page. That page is the workspace-level view for memory state, target selection, in-app retrieval search, target-scoped graph builds, and safe wrapper commands.
89110

90111
### Mixed Stack
91112

@@ -131,7 +152,8 @@ Current policy:
131152
- keep `.agents/skills/` only when repo-local compatibility mirroring helps
132153
- install upstream skills selectively
133154
- keep secrets and machine-specific MCP config local-only
134-
- default MCP examples to `read-only` capability tiers and opt into `mutating` only when required
155+
- keep the official MCP v1 server set small: `openaiDeveloperDocs`, `context7`, `playwright`, `chrome-devtools`, and `github`
156+
- treat `default-full` as the convenience default and `safe-readonly` as the downgrade path
135157
- keep third-party orchestration local-only unless it proves itself
136158
- if you trial `oh-my-codex`, treat it as an optional external layer or dedicated fork, not as a normal workspace dependency
137159

@@ -210,16 +232,33 @@ When a reviewed upstream becomes part of how the whole workspace works, promote
210232

211233
## Recommended first run
212234

213-
### 1. Read the docs
235+
### 1. Try Workspace Hub first
236+
237+
Run:
214238

215-
Start with:
239+
```bash
240+
cd repos/workspace-hub
241+
pnpm install
242+
pnpm dev
243+
```
244+
245+
Then use the app in this order:
246+
247+
1. `Workspace memory`
248+
2. target selection
249+
3. in-app retrieval search
250+
4. graph build or rebuild if you want the graph artifacts
251+
252+
### 2. Read only the docs you need next
253+
254+
If the Hub trial was useful and you want the broader workspace path, continue with:
216255

217256
- `README.md`
218257
- `docs/README.md`
219258
- `docs/08-first-run-and-updates.md`
220259
- `AGENTS.md`
221260

222-
### 2. Run the doctor script
261+
### 3. Run the doctor script
223262

224263
Use the non-destructive environment check:
225264

@@ -237,7 +276,7 @@ This reports:
237276
- Codex-related skill and config state
238277
- recommended setup profiles
239278

240-
### 2a. Bootstrap the workspace safely
279+
### 3a. Bootstrap the workspace safely
241280

242281
Use the workspace bootstrap helper when you want one command that prepares the
243282
safe cache/context folders and, if needed, installs `workspace-hub`
@@ -250,7 +289,7 @@ tools/scripts/bootstrap-workspace.sh --run
250289

251290
This script does not rewrite nested repos under `repos/`.
252291

253-
### 3. Use the profile helper if you want guided next steps
292+
### 4. Use the profile helper if you want guided next steps
254293

255294
Run:
256295

@@ -270,7 +309,7 @@ tools/scripts/setup-workspace-profile.sh --profile ui-previews
270309

271310
This script does not install anything. It checks the selected profile and prints the next steps that fit it.
272311

273-
### 4. Pick the smallest profile that fits
312+
### 5. Pick the smallest profile that fits
274313

275314
Recommended order:
276315

@@ -284,7 +323,7 @@ Recommended order:
284323
8. `UI Previews` only for repos that actually need isolated component or page previews
285324
9. `Experimental Local` only as local-only tooling
286325

287-
### 5. Enable agent-specific additions carefully
326+
### 6. Enable agent-specific additions carefully
288327

289328
For Codex:
290329

@@ -315,13 +354,32 @@ This workspace now includes starter examples under `tools/templates/skills/` for
315354

316355
For MCP-specific planning, this workspace also includes starter examples under `tools/templates/mcp/` for:
317356

318-
- `read-only` versus `mutating` capability tiers
357+
- official workspace profiles under `tools/templates/mcp/profiles/`
358+
- the approved v1 server catalog under `tools/templates/mcp/servers/`
359+
- local-only env examples under `tools/templates/mcp/env/`
360+
- generic `read-only` versus `mutating` capability tiers
319361
- stdio transport hygiene
320-
- local-only secret handling
321362

322363
Treat those as design ideas, not as a reason to add a second mandatory agent platform to the workspace.
323364

324-
### 6. Add spec-driven or preview tooling only where it helps
365+
If you want the supported Codex MCP path rather than the generic planning templates, use:
366+
367+
```bash
368+
tools/scripts/install-mcp-profile.sh --list
369+
tools/scripts/install-mcp-profile.sh default-full
370+
tools/scripts/install-mcp-profile.sh --run default-full
371+
tools/scripts/check-mcp-health.sh --profile default-full
372+
```
373+
374+
The official MCP docs now live in:
375+
376+
- `docs/15-mcp-profiles-and-trust-levels.md`
377+
- `docs/16-mcp-profiles.md`
378+
- `docs/17-mcp-install-and-health-check.md`
379+
- `docs/18-mcp-server-catalog.md`
380+
- `docs/19-mcp-authoring-rules.md`
381+
382+
### 7. Add spec-driven or preview tooling only where it helps
325383

326384
For larger changes:
327385

@@ -435,6 +493,23 @@ This includes:
435493

436494
These should not be treated as tracked workspace state.
437495

496+
### 5a. Re-apply or verify the managed Codex MCP profile when needed
497+
498+
If the tracked MCP docs, templates, wrappers, or the selected profile changed:
499+
500+
```bash
501+
tools/scripts/install-mcp-profile.sh default-full
502+
tools/scripts/install-mcp-profile.sh --run default-full
503+
tools/scripts/check-mcp-health.sh --profile default-full
504+
```
505+
506+
If you want the smallest supported MCP surface instead:
507+
508+
```bash
509+
tools/scripts/install-mcp-profile.sh --run safe-readonly
510+
tools/scripts/check-mcp-health.sh --profile safe-readonly
511+
```
512+
438513
If you keep reviewed GitHub-backed upstreams for comparison or local catalog use, update them separately too:
439514

440515
```bash
@@ -459,6 +534,7 @@ Codex usually detects skill changes automatically, but restart it if:
459534
- a newly installed skill does not appear
460535
- a disabled or enabled skill does not reflect config changes
461536
- a new MCP setup is not being picked up
537+
- a shell-only MCP auth env var is present but the desktop app still reports missing auth
462538

463539
## Updating skills specifically
464540

docs/12-maintainer-runbook.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,20 @@ Recommended when you maintain forks, pull requests, or reviewed upstream mirrors
3333

3434
- install `gh`
3535
- run `gh auth login`
36+
- install `codex` if you want to use the managed MCP profile flow locally
3637

3738
This is a maintainer convenience, not a release-gate requirement.
3839

40+
## Collaboration defaults across repos
41+
42+
If a repo does not define its own clearer workflow, use [14-git-and-github-workflow.md](14-git-and-github-workflow.md) as the workspace baseline.
43+
44+
For maintenance work, the practical implication is simple:
45+
46+
- check first whether the target repo overrides the workspace baseline
47+
- if it does not, follow `14-git-and-github-workflow.md` rather than copying a second workflow into repo-local notes
48+
- `gh` remains recommended convenience tooling rather than a clean-clone requirement
49+
3950
## Capability lifecycle
4051

4152
Tracked installable workspace abilities and core services are declared in:
@@ -98,6 +109,37 @@ tools/bin/mempalace-sync
98109

99110
Workspace Hub should surface MemPalace as a core service, but these commands remain the direct shell fallback.
100111

112+
## Codex MCP profile management
113+
114+
The official workspace MCP v1 surface is intentionally small and documented in:
115+
116+
- `docs/15-mcp-profiles-and-trust-levels.md`
117+
- `docs/16-mcp-profiles.md`
118+
- `docs/17-mcp-install-and-health-check.md`
119+
120+
Useful maintainer commands:
121+
122+
```bash
123+
tools/scripts/install-mcp-profile.sh --list
124+
tools/scripts/install-mcp-profile.sh default-full
125+
tools/scripts/install-mcp-profile.sh --run default-full
126+
tools/scripts/check-mcp-health.sh --profile default-full
127+
```
128+
129+
If you want the smallest supported profile instead:
130+
131+
```bash
132+
tools/scripts/install-mcp-profile.sh --run safe-readonly
133+
tools/scripts/check-mcp-health.sh --profile safe-readonly
134+
```
135+
136+
Rules:
137+
138+
- tracked examples stay in `tools/templates/mcp/` and repo-local `.workspace/mcp/`
139+
- generated overlays stay in ignored `tools/local/agents/codex/`
140+
- the installer manages only the Codex Workspace MCP block in the active Codex config
141+
- real credentials stay local-only
142+
101143
## Verification pass
102144

103145
Before handing off a workspace-maintenance slice:
@@ -113,6 +155,13 @@ pnpm --dir "repos/workspace-hub" test
113155

114156
Add `pnpm --dir "repos/workspace-hub" lint` when frontend or server code changed.
115157

158+
If MCP scripts, templates, or docs changed, also run:
159+
160+
```bash
161+
tools/scripts/install-mcp-profile.sh default-full
162+
tools/scripts/check-mcp-health.sh --profile default-full
163+
```
164+
116165
Public-file review step:
117166

118167
- review the root `README.md`, `docs/README.md`, `docs/CHANGELOG.md`, and any affected repo-local docs when a new feature lands

0 commit comments

Comments
 (0)