Skip to content

Commit f8b3e1c

Browse files
jpicklykclaude
andcommitted
docs: simplify default docker config; move project mount to advanced section
Remove -v workspaceFolder and -e AGENT_CONFIG_DIR from Options A and B. Server runs in schema-free mode by default — project mount is only needed for custom note schemas. Add Advanced section explaining the project mount should only appear in per-project .mcp.json (Option B), not global registrations (Option A), to avoid per-project schema bleed on shared configs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 463e615 commit f8b3e1c

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,6 @@ claude mcp add-json mcp-task-orchestrator '{
7474
"args": [
7575
"run", "--rm", "-i",
7676
"-v", "mcp-task-data:/app/data",
77-
"-v", "${workspaceFolder}:/project:ro",
78-
"-e", "AGENT_CONFIG_DIR=/project",
7977
"ghcr.io/jpicklyk/task-orchestrator:latest"
8078
]
8179
}'
@@ -95,8 +93,6 @@ Add to `.mcp.json` in your project root (checked into source control so teammate
9593
"args": [
9694
"run", "--rm", "-i",
9795
"-v", "mcp-task-data:/app/data",
98-
"-v", "${workspaceFolder}:/project:ro",
99-
"-e", "AGENT_CONFIG_DIR=/project",
10096
"ghcr.io/jpicklyk/task-orchestrator:latest"
10197
]
10298
}
@@ -110,6 +106,31 @@ The `mcp-task-data` Docker volume persists the SQLite database across container
110106

111107
Configure your client with the same JSON as Option A above. STDIO transport works with any MCP-compatible client.
112108

109+
### Advanced: Per-Project Note Schemas
110+
111+
By default the server runs in schema-free mode — all 13 tools work with no additional configuration. If you want to define custom note schemas that gate role transitions (e.g., require an acceptance-criteria note before a work item can advance), you can point the server at your project's `.taskorchestrator/config.yaml`.
112+
113+
Add the project mount to your **Option B** `.mcp.json` only (not the global Option A registration — a globally-registered server should not have its schema config vary per project):
114+
115+
```json
116+
{
117+
"mcpServers": {
118+
"mcp-task-orchestrator": {
119+
"command": "docker",
120+
"args": [
121+
"run", "--rm", "-i",
122+
"-v", "mcp-task-data:/app/data",
123+
"-v", "${workspaceFolder}:/project:ro",
124+
"-e", "AGENT_CONFIG_DIR=/project",
125+
"ghcr.io/jpicklyk/task-orchestrator:latest"
126+
]
127+
}
128+
}
129+
}
130+
```
131+
132+
See [Workflow Guide](current/docs/workflow-guide.md) for the `.taskorchestrator/config.yaml` schema format and examples.
133+
113134
### Step 3: Claude Code Plugin (optional)
114135

115136
Install the plugin for workflow skills, session-start hooks, and an orchestrator output style:

0 commit comments

Comments
 (0)